Class Poll<T, U, V>

constructor

• new Poll<T, U, V>(options): 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>

Readonly name

disposed

• get disposed(): ISignal<this, void>

• A signal emitted when the poll is disposed.

  Returns ISignal<this, void>

frequency

• get frequency(): Frequency

• The polling frequency parameters.

  Returns Frequency
• set frequency(frequency): void

• The polling frequency data.

  Parameters

  • frequency: Frequency

  Returns void

isDisposed

• get isDisposed(): boolean

• Whether the poll is disposed.

  Returns boolean

standby

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

• Indicates when the poll switches to standby.

  Returns Standby | (() => boolean | Standby)
• set standby(standby): void

• Parameters

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

  Returns void

state

• get state(): State<T, U, V>

• The poll state, which is the content of the current poll tick.

  Returns State<T, U, V>

tick

• get tick(): Promise<this>

• A promise that resolves when the poll next ticks.

  Returns Promise<this>

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>>

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<State<T, U, V>>

• Return an async iterator that yields every tick.

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

dispose

• dispose(): void

• Dispose the poll.

  Returns void

refresh

• refresh(): Promise<void>

• Refreshes the poll. Schedules refreshed tick if necessary.

  Returns Promise<void>

  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;

schedule

• schedule(next?): Promise<void>

• Schedule the next poll tick.

  Parameters

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

    The next poll state data to schedule. Defaults to standby.

  Returns Promise<void>

  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.

start

• start(): Promise<void>

• Starts the poll. Schedules started tick if necessary.

  Returns Promise<void>

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

stop

• stop(): Promise<void>

• Stops the poll. Schedules stopped tick if necessary.

  Returns Promise<void>

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