Interface IAbortAblePromiseBase<T>

a promise like object that has an abort method

interface IAbortAblePromiseBase<T> {
    abort(): void;
    isAborted(): boolean;
    then<TResult1 = T, TResult2 = never>(
        onfulfilled?: null | (value: T) => TResult1 | PromiseLike<TResult1>,
        onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
    ): IAbortAblePromiseBase<TResult1 | TResult2>;
}

Methods

isAborted(): boolean
whether this promise was aborted

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

then<TResult1 = T, TResult2 = never>(
onfulfilled?: null | (value: T) => TResult1 | PromiseLike<TResult1>,
onrejected?: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>,
): IAbortAblePromiseBase<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: null | (value: T) => TResult1 | PromiseLike<TResult1>
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | (reason: unknown) => TResult2 | PromiseLike<TResult2>
  The callback to execute when the Promise is rejected.
Returns IAbortAblePromiseBase<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Overrides PromiseLike.then
- Defined in src/abortAble.ts:9