Interface Options

Options for the StreamingClient

interface Options {
    apiVersion: string;
    channel: string;
    handshakeTimeout: Duration;
    org: Org;
    streamingImpl: StreamingClientIfc;
    streamProcessor: StreamProcessor;
    subscribeTimeout: Duration;
}

Properties

apiVersion: string

The salesforce api version

channel: string

The streaming channel aka topic

handshakeTimeout: Duration

The hard timeout that happens with a handshake.

org: Org

The org streaming target.

The function for build the inner client impl. Allows for mocking.

streamProcessor: StreamProcessor

The function for processing streaming messages

subscribeTimeout: Duration

The hard timeout that happens with subscribe