Class ZipStreamWriter

Index

Constructors

Methods

addBuffer addDirectory addFile addStream finalize

Constructors

constructor

new ZipStreamWriter(out: Writable, options?: ZipWriterOptions): ZipStreamWriter
Parameters
- out: Writable
- options: ZipWriterOptions = {}
Returns ZipStreamWriter
- Defined in models/zip-writer.ts:91

Methods

addBuffer

addBuffer(
    name: string,
    data: Buffer,
    options?: { mode?: number; mtime?: Date },
): Promise<void>
Add an entry from content held in memory
Parameters
- name: string
- data: Buffer
- options: { mode?: number; mtime?: Date } = {}
Returns Promise<void>
- Defined in models/zip-writer.ts:275

addDirectory

addDirectory(
name: string,
options?: { mode?: number; mtime?: Date },
): Promise<void>
Add a directory entry
Parameters
- name: string
- options: { mode?: number; mtime?: Date } = {}
Returns Promise<void>
- Defined in models/zip-writer.ts:297

addFile

addFile(name: string, localPath: string): Promise<void>
Add an entry read from a file on disk. The file is streamed.
Parameters
- name: string
- localPath: string
Returns Promise<void>
- Defined in models/zip-writer.ts:287

addStream

addStream(
    name: string,
    source: Readable,
    options?: { mode?: number; mtime?: Date; sizeHint?: number },
): Promise<void>
Add an entry whose contents come from a stream.

Whether an entry is zip64 has to be settled before any of its data is written, so a source of unknown length is read ahead of up to probeLimit bytes to find out which it is.
Parameters
- name: string
- source: Readable
- options: { mode?: number; mtime?: Date; sizeHint?: number } = {}
  - Optionalmode?: number
  - Optionalmtime?: Date
  - OptionalsizeHint?: number
    how large the source is known to be, if it is
Returns Promise<void>
- Defined in models/zip-writer.ts:173

finalize

finalize(): Promise<void>
Write the central directory and the end of central directory records. The writer cannot be used afterwards.

Returns Promise<void>
- Defined in models/zip-writer.ts:369