Providers
Subscriber
A Subscriber manages a subscription.
Only developers sub-classing AbstractProvider will care about this, if they are modifying a low-level feature of how subscriptions operate.
Properties
| Property | Type | Description |
|---|---|---|
pollingInterval? | number | The frequency (in ms) to poll for events, if polling is used by the subscriber. For non-polling subscribers, this must return undefined. |
Methods
pause()
pause(dropWhilePaused?): void
Called when the subscription should pause.
If dropWhilePaused, events that occur while paused should not be emitted
Subscriber.resume.
Parameters
| Parameter | Type | Description |
|---|---|---|
dropWhilePaused? | boolean | If true, events that occur while paused |
Returns
void
Source
providers/abstract-provider.ts:213
resume()
resume(): void
Resume a paused subscriber.
Returns
void
Source
providers/abstract-provider.ts:218
start()
start(): void
Called initially when a subscriber is added the first time.
Returns
void
Source
providers/abstract-provider.ts:198
stop()
stop(): void
Called when there are no more subscribers to the event.
Returns
void
Source
Was this page helpful?