WaitResult | async-wrappers

A promise will resolve with a value when wait is complete.

Type parameters

T

the type of the value.

Hierarchy

Promise<T>
- WaitResult

Index

Properties

Methods

Properties

Promise

Promise: PromiseConstructor

[Symbol.toStringTag]

[Symbol.toStringTag]: string

cancel

cancel: (error?: Error) => void

Causes the promise to reject.

param: If suplied this will be the error the promise rejects with.

Type declaration

- (error?: Error): void
- Parameters
  - Optional error: Error
  Returns void

stop

stop: () => void

Stops waiting this will cause any waiting values to be resolved on the next runtime loop.

Type declaration

- (): void
- Returns void

Methods

catch

catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>

Inherited from WaitResult.catch
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1430
Attaches a callback for only the rejection of the Promise.

Type parameters
- TResult
Parameters
- Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>

A Promise for the completion of the callback.

finally

finally(onfinally?: (() => void) | undefined | null): Promise<T>

Inherited from WaitResult.finally
- Defined in node_modules/typescript/lib/lib.es2018.promise.d.ts:31
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters
- Optional onfinally: (() => void) | undefined | null
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>

A Promise for the completion of the callback.

then

then<TResult1, TResult2>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>

Inherited from WaitResult.then
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1423
Attaches callbacks for the resolution and/or rejection of the Promise.

Type parameters
- TResult1
- TResult2
Parameters
- Optional onfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null
  
  The callback to execute when the Promise is resolved.
- Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>

A Promise for the completion of which ever callback is executed.

Generated using TypeDoc