Skip to content

Function: compressPayload() ​

ts
function compressPayload(
  buf: Buffer,
  options?: JobOptions,
): Promise<Buffer<ArrayBufferLike>>;

Gzip a buffer and prepend the "gz:" prefix. Passthrough if disabled.

Parameters ​

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

Returns ​

Promise<Buffer<ArrayBufferLike>>

Original or prefixed gzip bytes.