Type Alias ConvertResult

type ConvertResult = {
    converted?: SourceComponent[];
    deleted?: FileResponseSuccess[];
    packagePath?: SourcePath;
    zipBuffer?: Buffer;
    zipFileCount?: number;
}

Properties

Converted source components. Not set if archiving the package.

Components that were deleted (ex: decomposed children no longer present in the composed parent)

packagePath?: SourcePath

Location of converted package. Undefined if outputDirectory is omitted from output config.

zipBuffer?: Buffer

Buffer of converted package. Undefined if outputDirectory is omitted from zip output config.

zipFileCount?: number

When a zip buffer is created, this is the number of files in the zip.