Class PortPromise<T>

PortPromise extends HsPromise and integrates with a message port for resolving promises. It implements the ITickable interface for periodic updates.

Type Parameters

Hierarchy (View Summary)

HsPromise<T>
- PortPromise

Implements

TimerService.ITickable

Index

Constructors

constructor

new PortPromise<T>(port: ISGROMessagePort, maxMs?: number): PortPromise<T>
Creates a new PortPromise instance.
Type Parameters
- T
Parameters
- port: ISGROMessagePort
  The message port to use for resolving the promise.
- maxMs: number = 30000
  The maximum time in milliseconds to wait for a message before rejecting the promise.
Returns PortPromise<T>
Overrides HsPromise.constructor
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:199

Properties

`Private`currentMs

currentMs: number = 0

id

id: string = ''

A unique identifier for the promise.

`Private`maxMs

maxMs: number = 0

Methods

_tick

_tick(delta?: number): void
Periodic update method for checking the message port. Resolves the promise when a message is received.
Parameters
- Optionaldelta: number
  The time delta since the last update.
Returns void
Implementation of ITickable._tick
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:214

catch

catch(onRejected?: (reason: any) => T | HsPromise<T>): HsPromise<T>
Attaches a callback for when the promise is rejected.
Parameters
- OptionalonRejected: (reason: any) => T | HsPromise<T>
  A callback to execute when the promise is rejected.
Returns HsPromise<T>
A new HsPromise that resolves or rejects based on the provided callback.
Inherited from HsPromise.catch
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:148

finally

finally(callback: () => void): HsPromise<T>
Attaches a callback that is executed when the promise is settled, regardless of its outcome.
Parameters
- callback: () => void
  A callback to execute when the promise is settled.
Returns HsPromise<T>
A new HsPromise that resolves or rejects based on the original promise.
Inherited from HsPromise.finally
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:157

reject

reject(reason?: any): void
Rejects the promise with the specified reason.
Parameters
- Optionalreason: any
  The reason for rejecting the promise.
Returns void
Inherited from HsPromise.reject
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:80

resolve

resolve(value?: T): void
Resolves the promise with the specified value.
Parameters
- Optionalvalue: T
  The value to resolve the promise with.
Returns void
Inherited from HsPromise.resolve
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:67

then

then<TResult>(
onFulfilled?: (value: T) => TResult | HsPromise<TResult>,
onRejected?: (reason: any) => TResult | HsPromise<TResult>,
): HsPromise<TResult>
Attaches callbacks for the fulfillment and rejection of the promise.
Type Parameters
- TResult
Parameters
- OptionalonFulfilled: (value: T) => TResult | HsPromise<TResult>
  A callback to execute when the promise is fulfilled.
- OptionalonRejected: (reason: any) => TResult | HsPromise<TResult>
  A callback to execute when the promise is rejected.
Returns HsPromise<TResult>
A new HsPromise that resolves or rejects based on the provided callbacks.
Inherited from HsPromise.then
- Defined in hosanna-ui/src/hosanna-bridge-lib/Promises.ts:95

Class PortPromise<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PortPromise<T>

Properties

`Private`currentMs

id

`Private`maxMs

Methods

_tick

Parameters

Returns void

catch

Parameters

Returns HsPromise<T>

finally

Parameters

Returns HsPromise<T>

reject

Parameters

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns HsPromise<TResult>

Settings

On This Page

Class PortPromise<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PortPromise<T>

Properties

PrivatecurrentMs

id

PrivatemaxMs

Methods

_tick

Parameters

Returns void

catch

Parameters

Returns HsPromise<T>

finally

Parameters

Returns HsPromise<T>

reject

Parameters

Returns void

resolve

Parameters

Returns void

then

Type Parameters

Parameters

Returns HsPromise<TResult>

Settings

On This Page

`Private`currentMs

`Private`maxMs