Class TimeoutPromise<T>

Type Parameters

T = unknown

Implements

Promise<T | void>

Index

Constructors

constructor

new TimeoutPromise<T>(inner, __namedParameters?): TimeoutPromise<T>
Type Parameters
- T = unknown
Parameters
- inner: Promise<T>
- __namedParameters: TimeoutPromiseOptions = {}
Returns TimeoutPromise<T>
- Defined in packages/realm/src/TimeoutPromise.ts:32

Properties

catch

catch: (<TResult>(onrejected?) => Promise<void | T | TResult>) = ...

Type declaration

- <TResult>(onrejected?): Promise<void | T | TResult>
- Attaches a callback for only the rejection of the Promise.
  Type Parameters
  - TResult = never
  Parameters
  - Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)
    The callback to execute when the Promise is rejected.
  Returns Promise<void | T | TResult>
  A Promise for the completion of the callback.

finally

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

Type declaration

- (onfinally?): Promise<void | 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
  - Optional onfinally: null | (() => void)
    The callback to execute when the Promise is settled (fulfilled or rejected).
  Returns Promise<void | T>
  A Promise for the completion of the callback.

then

then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => Promise<TResult1 | TResult2>) = ...

Type declaration

- <TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
- Attaches callbacks for the resolution and/or rejection of the Promise.
  Type Parameters
  - TResult1 = void | T
  - TResult2 = never
  Parameters
  - Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
    The callback to execute when the Promise is resolved.
  - Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
    The callback to execute when the Promise is rejected.
  Returns Promise<TResult1 | TResult2>
  A Promise for the completion of which ever callback is executed.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of Promise.[toStringTag]
- Defined in packages/realm/src/TimeoutPromise.ts:61

Methods

cancel

cancel(): void
Returns void
- Defined in packages/realm/src/TimeoutPromise.ts:50

Class TimeoutPromise<T>

Type Parameters

T = unknown

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = unknown

Parameters

inner: Promise<T>

__namedParameters: TimeoutPromiseOptions = {}

Returns TimeoutPromise<T>

Properties

catch

Type declaration

Type Parameters

TResult = never

Parameters

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

Returns Promise<void | T | TResult>

finally

Type declaration

Parameters

Optional onfinally: null | (() => void)

Returns Promise<void | T>

then

Type declaration

Type Parameters

TResult1 = void | T

TResult2 = never

Parameters

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

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

Returns Promise<TResult1 | TResult2>

Accessors

[toStringTag]

Returns string

Methods

cancel

Returns void

Settings

Member Visibility

Theme

On This Page

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

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

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

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