Class: EventStream

EventStream(client, streamPosition, optionsopt)

Stream of Box events from a given client and point in time.

Constructor

new EventStream(client, streamPosition, optionsopt)

Parameters:
Name Type Attributes Description
client BoxClient The client to use to get events
streamPosition string The point in time to start at
options Object <optional>
Optional parameters
Properties
Name Type Attributes Default Description
retryDelay int <optional>
1000 Number of ms to wait before retrying after an error
deduplicationFilterSize int <optional>
5000 Number of IDs to track for deduplication
fetchInterval int <optional>
1000 Minimunm number of ms between calls for more events
Source:

Extends

  • Readable

Methods

destroy() → {void}

Destroys the stream. Rough polyfill for `Readable#destroy`.
Source:
Returns:
Type
void