method

zlib.ZipFile.stream

name: string,
options?: ZipEntryContentIterOptions
): Promise<Readable>;

Convenience wrapper that resolves to a Readable over zipEntry.contentIterator() of zipFile.get(name); the compressed bytes are read from disk as the stream is consumed. The returned promise rejects with ERR_ZIP_ENTRY_NOT_FOUND if the archive has no entry named name.

@returns

Promise fulfilled with a stream.Readable of the member's decompressed content, without buffering the whole member in memory.

Referenced types

interface ZipEntryContentIterOptions

  • maxSize?: number

    Reject content declaring more than this many uncompressed bytes, before decompressing anything.

  • verify?: boolean

    Verify the entry's CRC-32 checksum.