Class Poll<T, U, V>

A class that wraps an asynchronous function to poll at a regular interval with exponential increases to the interval length if the poll fails.

Typeparam

T - The resolved type of the factory's promises. Defaults to any.

Typeparam

U - The rejected type of the factory's promises. Defaults to any.

Typeparam

V - An optional type to extend the phases supported by a poll. Defaults to standby, which already exists in the Phase type.

Type Parameters

T = any
U = any
V extends string = "standby"

Hierarchy

Poll

Implements

IObservableDisposable
IPoll<T, U, V>

Index

Constructors

constructor

new Poll<T, U, V>(options: Poll.IOptions<T, U, V>): Poll<T, U, V>
Instantiate a new poll with exponential backoff in case of failure.
Type Parameters
- T = any
- U = any
- V extends string = "standby"
Parameters
- options: Poll.IOptions<T, U, V>
  
  The poll instantiation options.
Returns Poll<T, U, V>
- Defined in packages/polling/src/poll.ts:33

Properties

`Private` _disposed

_disposed: Signal<Poll<T, U, V>, void> = ...

`Private` _factory

_factory: Factory<T, U, V>

`Private` _frequency

_frequency: Frequency

`Private` _linger

_linger: number

`Private` _lingered

_lingered: number = 0

`Private` _standby

_standby: Standby | (() => boolean | Standby)

`Private` _state

_state: State<T, U, V>

`Private` _tick

_tick: PromiseDelegate<Poll<T, U, V>> = ...

`Private` _ticked

_ticked: Signal<Poll<T, U, V>, State<T, U, V>> = ...

`Private` _timeout

_timeout: undefined | number

`Readonly` name

name: string

The name of the poll.

Accessors

disposed

get disposed(): ISignal<this, void>
A signal emitted when the poll is disposed.

Returns ISignal<this, void>
Implementation of IPoll.disposed
- Defined in packages/polling/src/poll.ts:64

frequency

get frequency(): Frequency
The polling frequency parameters.

Returns Frequency
Implementation of IPoll.frequency
- Defined in packages/polling/src/poll.ts:71
set frequency(frequency: Frequency): void
The polling frequency data.
Parameters
- frequency: Frequency
Returns void
Implementation of IPoll.frequency
- Defined in packages/polling/src/poll.ts:74

`Protected` hidden

get hidden(): boolean
Whether the poll is hidden.

Notes

This property is only relevant in a browser context.

Returns boolean
- Defined in packages/polling/src/poll.ts:286

isDisposed

get isDisposed(): boolean
Whether the poll is disposed.

Returns boolean
Implementation of IPoll.isDisposed
- Defined in packages/polling/src/poll.ts:102

standby

get standby(): Standby | (() => boolean | Standby)
Indicates when the poll switches to standby.

Returns Standby | (() => boolean | Standby)
- Defined in packages/polling/src/poll.ts:109
set standby(standby: Standby | (() => boolean | Standby)): void
Parameters
- standby: Standby | (() => boolean | Standby)
Returns void
- Defined in packages/polling/src/poll.ts:112

state

get state(): State<T, U, V>
The poll state, which is the content of the current poll tick.

Returns State<T, U, V>
Implementation of IPoll.state
- Defined in packages/polling/src/poll.ts:123

tick

get tick(): Promise<this>
A promise that resolves when the poll next ticks.

Returns Promise<this>
Implementation of IPoll.tick
- Defined in packages/polling/src/poll.ts:130

ticked

get ticked(): ISignal<this, State<T, U, V>>
A signal emitted when the poll ticks and fires off a new request.

Returns ISignal<this, State<T, U, V>>
Implementation of IPoll.ticked
- Defined in packages/polling/src/poll.ts:137

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<State<T, U, V>>
Return an async iterator that yields every tick.

Returns AsyncIterableIterator<State<T, U, V>>
Implementation of IPoll.[asyncIterator]
- Defined in packages/polling/src/poll.ts:144

`Private` _execute

_execute(): void
Execute a new poll factory promise or stand by if necessary.

Returns void
- Defined in packages/polling/src/poll.ts:293

dispose

dispose(): void
Dispose the poll.

Returns void
Implementation of IObservableDisposable.dispose
- Defined in packages/polling/src/poll.ts:154

refresh

refresh(): Promise<void>
Refreshes the poll. Schedules refreshed tick if necessary.

Returns
A promise that resolves after tick is scheduled and never rejects.

Notes

The returned promise resolves after the tick is scheduled, but before the polling action is run. To wait until after the poll action executes, await the poll.tick promise: await poll.refresh(); await poll.tick;

Returns Promise<void>
- Defined in packages/polling/src/poll.ts:179

schedule

schedule(next?: Partial<State<T, U, V> & {
cancel: ((last: State<T, U, V>) => boolean);
}>): Promise<void>
Schedule the next poll tick.

Returns
A promise that resolves when the next poll state is active.

Notes

This method is not meant to be invoked by user code typically. It is public to allow poll instances to be composed into classes that schedule ticks.
Parameters
- next: Partial<State<T, U, V> & {
  cancel: ((last: State<T, U, V>) => boolean);
  }> = {}
  
  The next poll state data to schedule. Defaults to standby.
Returns Promise<void>
- Defined in packages/polling/src/poll.ts:200

start

start(): Promise<void>
Starts the poll. Schedules started tick if necessary.

Returns
A promise that resolves after tick is scheduled and never rejects.

Returns Promise<void>
- Defined in packages/polling/src/poll.ts:258

stop

stop(): Promise<void>
Stops the poll. Schedules stopped tick if necessary.

Returns
A promise that resolves after tick is scheduled and never rejects.

Returns Promise<void>
- Defined in packages/polling/src/poll.ts:272

Class Poll<T, U, V>

Typeparam

Typeparam

Typeparam

Type Parameters

T = any

U = any

V extends string = "standby"

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = any

U = any

V extends string = "standby"

Parameters

options: Poll.IOptions<T, U, V>

Returns Poll<T, U, V>

Properties

Private _disposed

Private _factory

Private _frequency

Private _linger

Private _lingered

Private _standby

Private _state

Private _tick

Private _ticked

Private _timeout

Readonly name

Accessors

disposed

Returns ISignal<this, void>

frequency

Returns Frequency

Parameters

frequency: Frequency

Returns void

Protected hidden

Notes

Returns boolean

isDisposed

Returns boolean

standby

Returns Standby | (() => boolean | Standby)

Parameters

standby: Standby | (() => boolean | Standby)

Returns void

state

Returns State<T, U, V>

tick

Returns Promise<this>

ticked

Returns ISignal<this, State<T, U, V>>

Methods

[asyncIterator]

Returns AsyncIterableIterator<State<T, U, V>>

Private _execute

Returns void

dispose

Returns void

refresh

Returns

Notes

Returns Promise<void>

schedule

Returns

Notes

Parameters

next: Partial<State<T, U, V> & { cancel: ((last: State<T, U, V>) => boolean); }> = {}

Returns Promise<void>

start

Returns

Returns Promise<void>

`Private` _disposed

`Private` _factory

`Private` _frequency

`Private` _linger

`Private` _lingered

`Private` _standby

`Private` _state

`Private` _tick

`Private` _ticked

`Private` _timeout

`Readonly` name

`Protected` hidden

`Private` _execute

next: Partial<State<T, U, V> & {
cancel: ((last: State<T, U, V>) => boolean);
}> = {}