Class NopePromise<T, E>

A Custom Implementation of Nope-Promise. They are cancelable.

Export

Implements

Type Parameters

T

Type of the Default Promise
E = any

Type of the Cancelation Data.

Hierarchy

Promise<T>
- NopePromise

Implements

INopePromise<T>

Index

Constructors

constructor

new NopePromise<T, E>(executor, cancel?, taskId?): NopePromise<T, E>
Creates an instance of NopePromise.

Memberof
NopePromise
Type Parameters
- T
- E = any
Parameters
- executor: ((resolve, reject) => void)
  - - (resolve, reject): void
    - Parameters
      
      resolve: ((value?) => void)
      
      (value?): void
      
      Parameters
      
      Optional value: T | PromiseLike<T>
      
      Returns void
      
      reject: ((reason?) => void)
      
      (reason?): void
      
      Parameters
      
      Optional reason: any
      
      Returns void
      
      Returns void
- Optional cancel: ((reason) => void)
  - - (reason): void
    - Parameters
      
      reason: E
      
      Returns void
- Optional taskId: string
Returns NopePromise<T, E>
Overrides Promise<T>.constructor
- Defined in lib/promise/nopePromise.ts:51

Properties

`Readonly` [toStringTag]

[toStringTag]: string

taskId

taskId: string

Attribute holding the Task-ID assinged by a dispatcher.

Memberof

NopePromise

`Static` `Readonly` [species]

[species]: PromiseConstructor

Methods

cancel

cancel(reason): void
Function used to cancel the Element.

Memberof
NopePromise
Parameters
- reason: E
Returns void
Implementation of INopePromise.cancel
- Defined in lib/promise/nopePromise.ts:32

catch

catch<TResult>(onrejected?): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.

Returns
A Promise for the completion of the callback.
Type Parameters
- TResult = never
Parameters
- Optional onrejected: ((reason) => TResult | PromiseLike<TResult>)
  
  The callback to execute when the Promise is rejected.
  - - (reason): TResult | PromiseLike<TResult>
    - Parameters
      
      reason: any
      
      Returns TResult | PromiseLike<TResult>
Returns Promise<T | TResult>
Implementation of INopePromise.catch

Inherited from Promise.catch
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1540

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.

Returns
A Promise for the completion of the callback.
Parameters
- Optional onfinally: (() => void)
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
  - - (): void
    - Returns void
Returns Promise<T>
Implementation of INopePromise.finally

Inherited from Promise.finally
- Defined in node_modules/typescript/lib/lib.es2018.promise.d.ts:31

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.

Returns
A Promise for the completion of which ever callback is executed.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: ((value) => TResult1 | PromiseLike<TResult1>)
  
  The callback to execute when the Promise is resolved.
  - - (value): TResult1 | PromiseLike<TResult1>
    - Parameters
      
      value: T
      
      Returns TResult1 | PromiseLike<TResult1>
- Optional onrejected: ((reason) => TResult2 | PromiseLike<TResult2>)
  
  The callback to execute when the Promise is rejected.
  - - (reason): TResult2 | PromiseLike<TResult2>
    - Parameters
      
      reason: any
      
      Returns TResult2 | PromiseLike<TResult2>
Returns Promise<TResult1 | TResult2>
Implementation of INopePromise.then

Inherited from Promise.then
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1533

`Static` all

all<T>(values): Promise<Awaited<T>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Returns
A new Promise.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An iterable of Promises.
Returns Promise<Awaited<T>[]>
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:227
all<T>(values): Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

Returns
A new Promise.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  
  An array of Promises.
Returns Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:41

`Static` allSettled

allSettled<T>(values): Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

Returns
A new Promise.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  
  An array of Promises.
Returns Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Inherited from Promise.allSettled
- Defined in node_modules/typescript/lib/lib.es2020.promise.d.ts:40
allSettled<T>(values): Promise<PromiseSettledResult<Awaited<T>>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

Returns
A new Promise.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
Inherited from Promise.allSettled
- Defined in node_modules/typescript/lib/lib.es2020.promise.d.ts:48

`Static` any

any<T>(values): Promise<Awaited<T[number]>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

Returns
A new Promise.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  
  An array or iterable of Promises.
Returns Promise<Awaited<T[number]>>
Inherited from Promise.any
- Defined in node_modules/typescript/lib/lib.es2021.promise.d.ts:42
any<T>(values): Promise<Awaited<T>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

Returns
A new Promise.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An array or iterable of Promises.
Returns Promise<Awaited<T>>
Inherited from Promise.any
- Defined in node_modules/typescript/lib/lib.es2021.promise.d.ts:49

`Static` race

race<T>(values): Promise<Awaited<T>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Returns
A new Promise.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  
  An iterable of Promises.
Returns Promise<Awaited<T>>
Inherited from Promise.race
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:235
race<T>(values): Promise<Awaited<T[number]>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Returns
A new Promise.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  
  An array of Promises.
Returns Promise<Awaited<T[number]>>
Inherited from Promise.race
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:52

`Static` reject

reject<T>(reason?): Promise<T>
Creates a new rejected promise for the provided reason.

Returns
A new rejected Promise.
Type Parameters
- T = never
Parameters
- Optional reason: any
  
  The reason the promise was rejected.
Returns Promise<T>
Inherited from Promise.reject
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:62

`Static` resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns
A resolved promise.

Returns Promise<void>
Inherited from Promise.resolve
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:68
resolve<T>(value): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.

Returns
A promise whose internal state matches the provided promise.
Type Parameters
- T
Parameters
- value: T
  
  A promise.
Returns Promise<Awaited<T>>
Inherited from Promise.resolve
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:74
resolve<T>(value): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.

Returns
A promise whose internal state matches the provided promise.
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
  
  A promise.
Returns Promise<Awaited<T>>
Inherited from Promise.resolve
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:80

Class NopePromise<T, E>

Export

Implements

Type Parameters

T

E = any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Type Parameters

T

E = any

Parameters

executor: ((resolve, reject) => void)

Parameters

resolve: ((value?) => void)

Parameters

Optional value: T | PromiseLike<T>

Returns void

reject: ((reason?) => void)

Parameters

Optional reason: any

Returns void

Returns void

Optional cancel: ((reason) => void)

Parameters

reason: E

Returns void

Optional taskId: string

Returns NopePromise<T, E>

Properties

Readonly [toStringTag]

taskId

Memberof

Static Readonly [species]

Methods

cancel

Memberof

Parameters

reason: E

Returns void

catch

Returns

Type Parameters

TResult = never

Parameters

Optional onrejected: ((reason) => TResult | PromiseLike<TResult>)

Parameters

reason: any

Returns TResult | PromiseLike<TResult>

Returns Promise<T | TResult>

finally

Returns

Parameters

Optional onfinally: (() => void)

Returns void

Returns Promise<T>

then

Returns

Type Parameters

TResult1 = T

TResult2 = never

Parameters

Optional onfulfilled: ((value) => TResult1 | PromiseLike<TResult1>)

Parameters

value: T

Returns TResult1 | PromiseLike<TResult1>

Optional onrejected: ((reason) => TResult2 | PromiseLike<TResult2>)

Parameters

reason: any

Returns TResult2 | PromiseLike<TResult2>

Returns Promise<TResult1 | TResult2>

Static all

Returns

`Optional` value: T | PromiseLike<T>

`Optional` reason: any

`Optional` cancel: ((reason) => void)

`Optional` taskId: string

`Readonly` [toStringTag]

`Static` `Readonly` [species]

`Optional` onrejected: ((reason) => TResult | PromiseLike<TResult>)

`Optional` onfinally: (() => void)

`Optional` onfulfilled: ((value) => TResult1 | PromiseLike<TResult1>)

`Optional` onrejected: ((reason) => TResult2 | PromiseLike<TResult2>)

`Static` all

Returns Promise<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>

`Static` allSettled

Returns Promise<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>

`Static` any

`Static` race

`Static` reject

`Optional` reason: any

`Static` resolve