Class RetrieveResultFile

constructor

• new RetrieveResultFile(properties, file?): RetrieveResultFile

• Parameters

  • properties: FileProperties

  • Optional file: JSZipObject

  Returns RetrieveResultFile

Readonly archivePath

Readonly componentName

Readonly componentType

Optional Readonly metaFilePath

Readonly packagePath

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

fileSize

• get fileSize(): number

• Uncompressed size of the file in bytes.

  Returns number

getBuffer

• getBuffer(): Promise<Buffer>

• Gets a buffer of the file contents.

  Returns Promise<Buffer>

  Buffer of the file contents.

getStream

• getStream(): ReadableStream

• Gets a readable stream of the file contents.

  Returns ReadableStream

  Stream of the file contents.

writeFile

• writeFile(targetFolder, options?): Promise<void>

• Extracts the file to the target folder and optionally the meta file.

  Parameters

  • targetFolder: string

    Target folder to extract the file to.

  • Optional options: {
        fileOnly?: boolean;
    }

    Additional options.

    • Optional fileOnly?: boolean

      If true only the file will be extracted, otherwise the full path will be used.

  Returns Promise<void>