tgzUtils

Index

Interfaces

• ConvertToZipOptions
• ExtractBufferOptions
• MakeArchiveFromDirectoryOptions

Type Aliases

• ConvertToZipPayload
• ZipWorkerPool

Functions

• convertToZip
• convertToZipWorker
• extractArchiveTo
• getDefaultTaskPool
• getTaskPoolForConfiguration
• makeArchiveFromDirectory

Interfaces

ConvertToZipOptions

ConvertToZipOptions:

optionalcompressionLevel

compressionLevel?: ZipCompression

optionalconfiguration

configuration?: Configuration

optionalprefixPath

prefixPath?: PortablePath

Inherited from ExtractBufferOptions.prefixPath

optionalstripComponents

stripComponents?: number

Inherited from ExtractBufferOptions.stripComponents

optionaltaskPool

taskPool?: ZipWorkerPool

ExtractBufferOptions

ExtractBufferOptions:

optionalprefixPath

prefixPath?: PortablePath

optionalstripComponents

stripComponents?: number

MakeArchiveFromDirectoryOptions

MakeArchiveFromDirectoryOptions:

optionalbaseFs

baseFs?: FakeFS<PortablePath>

optionalcompressionLevel

compressionLevel?: ZipCompression

optionalinMemory

inMemory?: boolean

optionalprefixPath

prefixPath?: null | PortablePath

Type Aliases

ConvertToZipPayload

ConvertToZipPayload: { compressionLevel: ZipCompression; extractBufferOpts: ExtractBufferOptions; tgz: Buffer | Uint8Array; tmpFile: PortablePath }

Type declaration

• compressionLevel: ZipCompression

• extractBufferOpts: ExtractBufferOptions

• tgz: Buffer | Uint8Array

• tmpFile: PortablePath

ZipWorkerPool

ZipWorkerPool: TaskPool<ConvertToZipPayload, PortablePath>

Functions

convertToZip

• convertToZip(tgz: Buffer, opts?: ConvertToZipOptions): Promise<ZipFS>

• Parameters

  • tgz: Buffer

  • opts: ConvertToZipOptions = {}

  Returns Promise<ZipFS>

convertToZipWorker

• convertToZipWorker(data: ConvertToZipPayload): Promise<PortablePath>

• Parameters

  • data: ConvertToZipPayload

  Returns Promise<PortablePath>

extractArchiveTo

• extractArchiveTo<T>(tgz: Buffer, targetFs: T, __namedParameters?: ExtractBufferOptions): Promise<T>

• Type parameters

  • T: FakeFS<PortablePath>

  Parameters

  • tgz: Buffer

  • targetFs: T

  • __namedParameters: ExtractBufferOptions = {}

  Returns Promise<T>

getDefaultTaskPool

• getDefaultTaskPool(): ZipWorkerPool

• Returns ZipWorkerPool

getTaskPoolForConfiguration

• getTaskPoolForConfiguration(configuration: void | Configuration): ZipWorkerPool

• Parameters

  • configuration: void | Configuration

  Returns ZipWorkerPool

makeArchiveFromDirectory

• makeArchiveFromDirectory(source: PortablePath, __namedParameters?: MakeArchiveFromDirectoryOptions): Promise<ZipFS>

• Parameters

  • source: PortablePath

  • __namedParameters: MakeArchiveFromDirectoryOptions = {}

  Returns Promise<ZipFS>