Skip to content

Function: compressPayloadSync() ​

ts
function compressPayloadSync(buf: Buffer, options?: JobOptions): Buffer;

Compresses bytes synchronously and prepends the gz: marker unless disabled.

Parameters ​

ParameterTypeDescription
bufBufferBytes to compress.
options?JobOptionsCompression options; compression is enabled unless disabled.

Returns ​

Buffer

Original bytes when disabled, otherwise gzip-prefixed compressed bytes.