Class Compress

constructor

• new Compress(opts: GzipOptions, cb?: FlateStreamHandler): Compress

  Creates a GZIP stream

  Parameters

  • opts: GzipOptions

    The compression options

  • Optionalcb: FlateStreamHandler

    The callback to call whenever data is deflated

  Returns Compress

• new Compress(cb?: FlateStreamHandler): Compress

  Creates a GZIP stream

  Parameters

  • Optionalcb: FlateStreamHandler

    The callback to call whenever data is deflated

  Returns Compress

flush

• flush(sync?: boolean): void

  Flushes buffered uncompressed data. Useful to immediately retrieve the GZIPped output for small inputs.

  Parameters

  • Optionalsync: boolean

    Whether to flush to a byte boundary. A sync flush takes 4-5 extra bytes, but guarantees all pushed data is immediately decompressible.

  Returns void

push

• push(chunk: Uint8Array, final?: boolean): void

  Pushes a chunk to be GZIPped

  Parameters

  • chunk: Uint8Array

    The chunk to push

  • Optionalfinal: boolean

    Whether this is the last chunk

  Returns void

ondata