Class CancelablePromise<T>

Type Parameters

T

Implements

Promise<T>

Index

Constructors

Accessors

[toStringTag] isCancelled

Methods

cancel catch finally then

Constructors

constructor

new CancelablePromise<T>(executor): CancelablePromise<T>
Type Parameters
- T
Parameters
- executor: ((resolve: ((value: T | PromiseLike<T>) => void), reject: ((reason?: any) => void), onCancel: OnCancel) => void)
  - - (resolve, reject, onCancel): void
    - Parameters
      resolve: ((value: T | PromiseLike<T>) => void)
      (value): void
      Parameters
      value: T | PromiseLike<T>
      Returns void
      reject: ((reason?: any) => void)
      (reason?): void
      Parameters
      Optionalreason: any
      Returns void
      onCancel: OnCancel
      Returns void
Returns CancelablePromise<T>
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:34

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of Promise.[toStringTag]
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:88

isCancelled

get isCancelled(): boolean
Returns boolean
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:128

Methods

cancel

cancel(): void
Returns void
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:109

catch

catch<TResult>(onRejected?): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- OptionalonRejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Implementation of Promise.catch
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:99

finally

finally(onFinally?): Promise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- OptionalonFinally: null | (() => void)
Returns Promise<T>
A Promise for the completion of the callback.
Implementation of Promise.finally
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:105

then

then<TResult1, TResult2>(onFulfilled?, onRejected?): Promise<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>)
- OptionalonRejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Implementation of Promise.then
- Defined in clients/typescript-axios/src/core/CancelablePromise.ts:92