Interface JetStreamOptions

Options to a JetStream options applied to all JetStream or JetStreamManager requests.

interface JetStreamOptions {
    apiPrefix?: string;
    domain?: string;
    timeout?: number;
}

Hierarchy (view full)

Properties

apiPrefix? domain? timeout?

Properties

Optional apiPrefix

apiPrefix?: string

Prefix required to interact with JetStream. Must match server configuration.

Optional domain

domain?: string

Name of the JetStream domain. This value automatically modifies the default JetStream apiPrefix.

Optional timeout

timeout?: number

Number of milliseconds to wait for a JetStream API request.

Default

ConnectionOptions.timeout

See

ConnectionOptions.timeout

Settings

Member Visibility

Theme

On This Page

apiPrefixdomaintimeout