Module "abortSignal"

module: This module contains interoperability with DOM AbortSignal and AbortSignal-like objects.

Index

Type aliases

AdaptableAbortSignalLike

Functions

Type aliases

AdaptableAbortSignalLike

AdaptableAbortSignalLike: Pick<AbortSignal, "aborted" | "addEventListener">

Represents an AbortSignal-like object with basic abort state and subscribable abort event.

Functions

abortSignalFromCancellationToken

abortSignalFromCancellationToken(cancellationToken: ICancellationToken): AbortSignal

- Defined in packages/tasklike-promise-library/src/abortSignal.ts:81
Gets an AbortSignal from ICancellationToken.

Parameters
- cancellationToken: ICancellationToken
  
  the source cancellation token.
Returns AbortSignal

a DOM AbortSignal instance, or an AbortSignal-like adapter provided by TPL if there is no native AbortSignal and AbortController available in the global environment.

cancellationTokenFromAbortSignal

cancellationTokenFromAbortSignal(abortSignal: AdaptableAbortSignalLike): ICancellationToken

- Defined in packages/tasklike-promise-library/src/abortSignal.ts:115
Gets an ICancellationToken from the specified AbortSignal.

Parameters
- abortSignal: AdaptableAbortSignalLike
  
  an abort signal that will cancel the returned ICancellationToken upon abort event.
Returns ICancellationToken

Generated using TypeDoc