Default Streaming Options. Uses Faye as the cometd impl.

Hierarchy

  • DefaultOptions

Implements

Constructors

  • Constructor for DefaultStreamingOptions

    Parameters

    • org: Org

      The streaming target org

    • channel: string

      The streaming channel or topic. If the topic is a system topic then api 36.0 is used. System topics are deprecated.

    • streamProcessor: StreamProcessor

      The function called that can process streaming messages.

    • envDep: Env = env

    Returns DefaultOptions

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.

streamProcessor: StreamProcessor

The function for processing streaming messages

streamingImpl: StreamingClientIfc

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

subscribeTimeout: Duration

The hard timeout that happens with subscribe

DEFAULT_HANDSHAKE_TIMEOUT: Duration = ...
DEFAULT_SUBSCRIBE_TIMEOUT: Duration = ...
SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'
SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'

Methods