HttpClientOptions

Configuration shared by every HttpClient.

Hierarchy

• HttpClientOptions
  • AxiosHttpClientOptions

Index

Properties

• compression
• headers
• logger
• maxRetries
• minDelayBetweenRetriesMillis
• stats
• timeoutLongSecs
• timeoutMaxSecs
• timeoutMediumSecs
• timeoutShortSecs
• token
• workflowKey

Properties

optionalcompression

compression?: HttpCompressionAlgorithm | HttpCompressor = HttpCompressionAlgorithm | HttpCompressor

Compression of request bodies: the name of a built-in algorithm, or an HttpCompressor for a custom quality or algorithm.

optionalheaders

headers?: Record<string, string>

Additional headers sent with every request. They win over the built-in defaults.

optionallogger

logger?: Log

Logger for the retry warnings. Defaults to a child of the @apify/log default with an ApifyClient prefix.

optionalmaxRetries

maxRetries?: number = 8

How many times a failed request is retried at most.

optionalminDelayBetweenRetriesMillis

minDelayBetweenRetriesMillis?: number = 500

Lower bound for the delay before the first retry in milliseconds. It doubles with every further retry.

optionalstats

stats?: Statistics

Statistics the client records its calls into. Created when omitted.

optionaltimeoutLongSecs

timeoutLongSecs?: number = 360

Duration of the long timeout tier, in seconds.

optionaltimeoutMaxSecs

timeoutMaxSecs?: number = 360

Upper bound for the timeout of a single attempt, in seconds.

optionaltimeoutMediumSecs

timeoutMediumSecs?: number = 30

Duration of the medium timeout tier, in seconds.

optionaltimeoutShortSecs

timeoutShortSecs?: number = 5

Duration of the short timeout tier, in seconds.

optionaltoken

token?: string

Apify API token, sent as a Bearer token in the Authorization header.

optionalworkflowKey

workflowKey?: string

Value of the X-Apify-Workflow-Key header. Defaults to the APIFY_WORKFLOW_KEY environment variable.