AbortOptions

Hierarchy

• RunAbortOptions
• Token
  • AbortOptions

Index

Properties

• gracefully
• signal
• statusMessage
• timeoutSecs
• token

Properties

externaloptionalinheritedgracefully

gracefully?: boolean

Inherited from RunAbortOptions.gracefully

externaloptionalinheritedsignal

signal?: AbortSignal

Inherited from RunAbortOptions.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.

optionalstatusMessage

statusMessage?: string

Exit with given status message

externaloptionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from RunAbortOptions.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.

optionalinheritedtoken

token?: string

Inherited from Token.token

User Apify API token that is used for API calls. By default, it is taken from the APIFY_TOKEN environment variable.