Class CancellablePromise<T>

Cancellable promise

Type Parameters

T

Hierarchy

CancellablePromise

Index

Constructors

Properties

cancelled onCancelHandler reject resolve

Methods

cancel catch onCancel onError onResolve then

Constructors

constructor

new CancellablePromise<T>(promise): CancellablePromise<T>
Type Parameters
- T
Parameters
- promise: Promise<T>
Returns CancellablePromise<T>
- Defined in src/utils/cancellable-promise.ts:18

Properties

cancelled

cancelled: boolean

True if cancelled

`Private` onCancelHandler

onCancelHandler: (() => void)

Type declaration

- (): void
- Returns void

`Private` reject

reject: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: Error
  Returns void

`Private` resolve

resolve: ((t) => void)

Type declaration

- (t): void
- Parameters
  - t: T
  Returns void

Methods

cancel

cancel(): void
Cancels the promise

Returns void
- Defined in src/utils/cancellable-promise.ts:46

catch

catch(onReject): CancellablePromise<T>
Sets promise rejection handler
Parameters
- onReject: ((e) => void)
  
  Handler
  - - (e): void
    - Parameters
      
      e: Error
      
      Returns void
Returns CancellablePromise<T>
This
- Defined in src/utils/cancellable-promise.ts:68

onCancel

onCancel(onCancel): CancellablePromise<T>
Sets promise cancel handler
Parameters
- onCancel: (() => void)
  
  Handler
  - - (): void
    - Returns void
Returns CancellablePromise<T>
This
- Defined in src/utils/cancellable-promise.ts:78

`Private` onError

onError(e): void
Parameters
- e: Error
Returns void
- Defined in src/utils/cancellable-promise.ts:33

`Private` onResolve

onResolve(t): void
Parameters
- t: T
Returns void
- Defined in src/utils/cancellable-promise.ts:23

then

then(onFullfil): CancellablePromise<T>
Sets promise fullfil handler
Parameters
- onFullfil: ((t) => void)
  
  Handler
  - - (t): void
    - Parameters
      
      t: T
      
      Returns void
Returns CancellablePromise<T>
This
- Defined in src/utils/cancellable-promise.ts:58

Generated using TypeDoc