TimeoutOptions

Options shared by every method that sends a request to the API.

Hierarchy

• TimeoutOptions
  • ActorStartOptions
  • ActorValidateInputOptions
  • ActorBuildOptions
  • ActorCollectionListOptions
  • BuildClientGetOptions
  • BuildClientWaitForFinishOptions
  • BuildCollectionClientListOptions
  • DatasetClientListItemOptions
  • DatasetCollectionClientListOptions
  • DatasetCollectionClientGetOrCreateOptions
  • KeyValueClientListKeysOptions
  • KeyValueClientGetRecordOptions
  • KeyValueStoreRecordOptions
  • KeyValueStoreCollectionClientListOptions
  • KeyValueStoreCollectionClientGetOrCreateOptions
  • LogOptions
  • RequestQueueClientListHeadOptions
  • RequestQueueClientListRequestsOptions
  • RequestQueueClientPaginateRequestsOptions
  • RequestQueueClientListAndLockHeadOptions
  • RequestQueueClientAddRequestOptions
  • RequestQueueClientProlongRequestLockOptions
  • RequestQueueClientDeleteRequestLockOptions
  • RequestQueueClientBatchAddRequestWithRetriesOptions
  • RequestQueueCollectionListOptions
  • GetStreamedLogOptions
  • RunGetOptions
  • RunAbortOptions
  • RunMetamorphOptions
  • RunResurrectOptions
  • RunChargeOptions
  • RunWaitForFinishOptions
  • RunCollectionListOptions
  • ScheduleCollectionListOptions
  • StoreCollectionListOptions
  • TaskCollectionListOptions
  • WebhookCollectionListOptions
  • WebhookDispatchCollectionListOptions

Index

Properties

• signal
• timeoutSecs

Properties

optionalsignal

signal?: AbortSignal

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.

optionaltimeoutSecs

timeoutSecs?: Timeout

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.