Class ZipBuilder

Builds a ZIP file.

Hierarchy

ZipBuilder

Index

Properties

Methods

Properties

Private Readonly _STEPS

_STEPS: ZipBuilderStep[] = []

Private _buffer

_buffer: Buffer | false = false

Methods

addBuffer

addBuffer(p: string, data: Buffer): this

- Defined in src/zip/builder.ts:41
Adds a buffer.

Parameters
- p: string
  
  The path in the zip file.
- data: Buffer
  
  The data to write.
Returns this

this

addDir

addDir(p: string): this

- Defined in src/zip/builder.ts:57
Adds an empty directory.

Parameters
- p: string
  
  The path in the zip file.
Returns this

this

addFiles

addFiles(dir: string, basePath?: string): this

- Defined in src/zip/builder.ts:72
Adds all files of a local directory.

Parameters
- dir: string
  
  The path of the local directory.
- Optional basePath: string
Returns this

Private createZipInstance

createZipInstance(): Promise<ZipFile>

- Defined in src/zip/builder.ts:111
Returns Promise<ZipFile>

toBuffer

toBuffer(): Promise<Buffer>

- Defined in src/zip/builder.ts:128
Creates a new ZIP file as buffer.

Returns Promise<Buffer>

The promise with the buffer.

Generated using TypeDoc