Class Abortable<T>

Type parameters

T

Hierarchy

Promise<T>
- Abortable
  - Process

Implements

AbortablePromiseLike<T>

Index

Constructors

constructor

Properties

Accessors

[Symbol.species]

Methods

Constructors

constructor

new Abortable(executor: AbortablePromiseExecutor<T>): Abortable

- Defined in src/Abortable.ts:67
Parameters
- executor: AbortablePromiseExecutor<T>
Returns Abortable

Properties

[Symbol.toStringTag]

[Symbol.toStringTag]: string

aapi

abort

abort: Promise<T>

abortWith

abortWith: (response?: Response<T>) => this

Type declaration

- (response?: Response<T>): this
- Parameters
  - Optional response: Response<T>
  Returns this

promise

promise: Promise<T>

Optional timeout

timeout: Timeout<T>

Static Promise

Promise: PromiseConstructor

Accessors

Static [Symbol.species]

get [Symbol.species](): PromiseConstructor

- Defined in src/Abortable.ts:16
Returns PromiseConstructor

Methods

catch

catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>

Inherited from CancellablePromiseLike.catch
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1430
Attaches a callback for only the rejection of the Promise.

Type parameters
- TResult
Parameters
- Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>

A Promise for the completion of the callback.

finally

finally(onfinally?: (() => void) | undefined | null): Promise<T>

Inherited from CancellablePromiseLike.finally
- Defined in node_modules/typescript/lib/lib.es2018.promise.d.ts:31
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters
- Optional onfinally: (() => void) | undefined | null
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>

A Promise for the completion of the callback.

then

then<TResult1, TResult2>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>

Inherited from CancellablePromiseLike.then
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1423
Attaches callbacks for the resolution and/or rejection of the Promise.

Type parameters
- TResult1
- TResult2
Parameters
- Optional onfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null
  
  The callback to execute when the Promise is resolved.
- Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>

A Promise for the completion of which ever callback is executed.

withAutoAbort

withAutoAbort(aapi: AbortApi, response?: Response<T>): this

Implementation of AbortablePromiseLike.withAutoAbort
- Defined in src/Abortable.ts:62
Parameters
- aapi: AbortApi
- Optional response: Response<T>
Returns this

withTimeout

withTimeout(timeout: Timeout<T>): Abortable<T>
withTimeout(duration: number, response?: Response<T>): Abortable<T>

- Defined in src/Abortable.ts:36
Parameters
- timeout: Timeout<T>
Returns Abortable<T>
- Defined in src/Abortable.ts:37
Parameters
- duration: number
- Optional response: Response<T>
Returns Abortable<T>

Static fromAsync

fromAsync<T>(executor: (aapi: AbortApi) => T | PromiseLike<T>): Abortable<T>

- Defined in src/Abortable.ts:20
Type parameters
- T
Parameters
- executor: (aapi: AbortApi) => T | PromiseLike<T>
  - - (aapi: AbortApi): T | PromiseLike<T>
    - Parameters
      - aapi: AbortApi
      Returns T | PromiseLike<T>
Returns Abortable<T>

Static fromPromise

fromPromise<T>(promise: T | PromiseLike<T>): Abortable<T>

- Defined in src/Abortable.ts:30
Type parameters
- T
Parameters
- promise: T | PromiseLike<T>
Returns Abortable<T>

Static reject

reject<T>(reason?: any): Abortable<T>

- Defined in src/Abortable.ts:133
Type parameters
- T
Parameters
- Optional reason: any
Returns Abortable<T>

Static resolve

resolve(): Abortable<void>

- Defined in src/Abortable.ts:128
Returns Abortable<void>

Generated using TypeDoc