Class RetrieveResultFile

constructor

• new RetrieveResultFile(
      componentProperties: SalesforcePackageComponent,
      fileProperties: FileProperties,
      contentFile?: JSZipObject,
      metaFile?: JSZipObject,
  ): RetrieveResultFile

  Parameters

  • componentProperties: SalesforcePackageComponent
  • fileProperties: FileProperties
  • OptionalcontentFile: JSZipObject
  • OptionalmetaFile: JSZipObject

  Returns RetrieveResultFile

ReadonlyarchivePath

ReadonlycomponentName

ReadonlycomponentType

ReadonlypackagePath

compressedSize

• get compressedSize(): number

  Compressed size of the file in bytes.

  Returns number

crc32

• get crc32(): undefined | number

  CRC32 checksum of the file.

  Returns undefined | number

fileName

• get fileName(): string

  Gets the base name of the archive file path, excluding any directory components.

  Returns string

  The file name portion of the archive path.

fileSize

• get fileSize(): number

  Uncompressed size of the file in bytes.

  Returns number

folderName

• get folderName(): string

  Gets the relative path of the archive file.

  Returns string

  The directory name of the archive path specified by this.archivePath.

fullPath

• get fullPath(): string

  Gets the full path of the file in the zip archive.

  Returns string

  See

  archivePath

content

• content(): Promise<Buffer<ArrayBufferLike>>

  Returns the content of the file as a buffer.

  Returns Promise<Buffer<ArrayBufferLike>>

expandMetadataFiles

• expandMetadataFiles(): Promise<Record<string, Buffer<ArrayBufferLike>>>

  Expand the metadata file into its constituent parts, such as content and metadata files. This method uses the MetadataExpander to expand the metadata file and returns a record of the expanded files.

  Returns Promise<Record<string, Buffer<ArrayBufferLike>>>

  A record of expanded files where the keys are the file names and the values are the file contents as buffers.

extractTo

• extractTo(targetFolder: string): Promise<string[]>

  Extracts and writes expanded metadata files to the specified target folder.

  This method uses the MetadataExpander to expand the current metadata object, then writes each expanded file to the given target directory. The method returns a list of the relative file paths that were written.

  Parameters

  • targetFolder: string

    The absolute or relative path to the folder where the expanded files will be written.

  Returns Promise<string[]>

  A promise that resolves to an array of file paths representing the files that were written.

getBuffer

• getBuffer(type?: "content"): Promise<Buffer<ArrayBufferLike>>

  Gets a buffer of the file contents.

  Parameters

  • Optionaltype: "content"

  Returns Promise<Buffer<ArrayBufferLike>>

  Buffer of the file contents.

• getBuffer(
      type?: RetrieveResultFileType,
  ): undefined | Promise<Buffer<ArrayBufferLike>>

  Gets a buffer of the file contents.

  Parameters

  • Optionaltype: RetrieveResultFileType

  Returns undefined | Promise<Buffer<ArrayBufferLike>>

  Buffer of the file contents.

getStream

• getStream(): ReadableStream

  Gets a readable stream of the file contents.

  Returns ReadableStream

  Stream of the file contents.

metadata

• metadata(): Promise<undefined | object & { "@type": string }>

  When metadata is split between content and meta files, this method returns the metadata associated to the content as (parsed) XML object.

  • If there are XML attributes they are grouped under the @attributes property.
  • The type of the metadata is stored in the @type property.

  Note: This only returns metadata for components that have a separate content and metadata files.

  Returns Promise<undefined | object & { "@type": string }>

read

• read(): Promise<Buffer<ArrayBufferLike>>

  Returns Promise<Buffer<ArrayBufferLike>>

  Deprecated

  Use content instead to read the file contents or use metadata to get the file metadata as XML object.