Type Alias ConvertResult

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

Type declaration

  • Optionalconverted?: SourceComponent[]

    Converted source components. Not set if archiving the package.

  • Optionaldeleted?: FileResponseSuccess[]

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

  • OptionalpackagePath?: SourcePath

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

  • OptionalzipBuffer?: Buffer

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

  • OptionalzipFileCount?: number

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

Settings

Member Visibility