ActorServerRequestOptions

Options of ActorServerClient.request.

Hierarchy

• TimeoutOptions
  • ActorServerRequestOptions

Index

Properties

• compression
• data
• headers
• method
• params
• responseType
• signal
• timeoutSecs

Properties

optionalcompression

compression?: HttpCompressionAlgorithm | HttpCompressor

Compression algorithm for the request body, as a name or an HttpCompressor. The body is sent uncompressed when it's not set, since the Actor's server may not decode a compressed body.

optionaldata

data?: unknown

Request body, serialized the same way as for API calls: a plain object or array is sent as JSON, and a string or binary value as it is.

optionalheaders

headers?: Record<string, string>

Additional headers of the request.

optionalmethod

method?: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH = GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH

HTTP method of the request.

optionalparams

params?: Record<string, unknown>

Query parameters of the request, converted the same way as for API calls.

optionalresponseType

responseType?: ApifyResponseType = ApifyResponseType

How to return the response body: 'parsed' by its content type, 'buffer' as raw bytes, or 'stream' as a Readable stream with the body unread. Node.js only.

optionalinheritedsignal

signal?: AbortSignal

Inherited from TimeoutOptions.signal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from TimeoutOptions.timeoutSecs

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.