GzipHttpCompressor

Compresses request bodies using gzip.

Built on the node:zlib module, so it works wherever the client runs on Node.js.

Implements

• HttpCompressor

import { ApifyClient, GzipHttpCompressor } from 'apify-client';

const client = new ApifyClient({ token: 'my-token', compression: new GzipHttpCompressor({ quality: 1 }) });

Index

Constructors

• constructor

Properties

• contentEncoding

Methods

• compress

Constructors

constructor

• new GzipHttpCompressor(options): GzipHttpCompressor

• ---

  Parameters

  • options: GzipHttpCompressorOptions = {}

    Compressor options.

  Returns GzipHttpCompressor

  Throws - If quality is out of the valid range.

Properties

readonlycontentEncoding

contentEncoding: gzip = 'gzip'

Implementation of HttpCompressor.contentEncoding

Value sent in the Content-Encoding header, for example gzip or br.

Methods

compress

• compress(data): Promise<Buffer<ArrayBufferLike>>

• Implementation of HttpCompressor.compress

  Compresses a request body.

  ---

  Parameters

  • data: Buffer<ArrayBufferLike>

    The raw bytes to compress.

  Returns Promise<Buffer<ArrayBufferLike>>

  The compressed bytes.