Class BroadcastScheduler<TTimer>

Debounced state-broadcast scheduler used by the host provider. Rapid state changes are coalesced into one broadcast after the latest change.

Type Parameters

TTimer = ReturnType<typeof setTimeout>

Index

Constructors

Methods

cancel hasPendingBroadcast schedule setStateThrottleMs

Constructors

constructor

new BroadcastScheduler<TTimer = number>(
options?: BroadcastSchedulerOptions<TTimer>,
): BroadcastScheduler<TTimer>
Type Parameters
- TTimer = number
Parameters
- options: BroadcastSchedulerOptions<TTimer> = {}
Returns BroadcastScheduler<TTimer>
- Defined in host/src/broadcast-scheduler.ts:35

Methods

cancel

cancel(): void
Returns void
- Defined in host/src/broadcast-scheduler.ts:51

hasPendingBroadcast

hasPendingBroadcast(): boolean
Returns boolean
- Defined in host/src/broadcast-scheduler.ts:62

schedule

schedule(callback: () => void): void
Parameters
- callback: () => void
Returns void
- Defined in host/src/broadcast-scheduler.ts:43

setStateThrottleMs

setStateThrottleMs(stateThrottleMs: number): void
Parameters
- stateThrottleMs: number
Returns void
- Defined in host/src/broadcast-scheduler.ts:58