Interface IAbortAblePromiseBase<T>

a promise like object that has an abort method

interface IAbortAblePromiseBase<T> {
    abort(): void;
    isAborted(): boolean;
    then<TResult1, TResult2>(onfulfilled?, onrejected?): IAbortAblePromiseBase<TResult1 | TResult2>;
}

Type Parameters

T

Hierarchy

PromiseLike<T>
- IAbortAblePromiseBase

Index

Methods

abort isAborted then

Methods

abort

abort(): void
abort the promise when possible

Returns void
- Defined in src/abortAble.ts:16

isAborted

isAborted(): boolean
whether this promise was aborted

Returns boolean
- Defined in src/abortAble.ts:20

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): IAbortAblePromiseBase<TResult1 | TResult2>
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
Returns IAbortAblePromiseBase<TResult1 | TResult2>
Overrides PromiseLike.then
- Defined in src/abortAble.ts:9