Interface PullOptions

Options for a JetStream pull subscription which define how long the pull request will remain open and limits the amount of data that the server could return.

interface PullOptions {
    batch: number;
    expires: number;
    idle_heartbeat: number;
    max_bytes: number;
    no_wait: boolean;
}

Properties

batch: number

Max number of messages to retrieve in a pull.

expires: number

If set, the number of milliseconds to wait for the number of messages specified in batch

idle_heartbeat: number
max_bytes: number

If set, the max number of bytes to receive. The server will limit the number of messages in the batch to fit within this setting.

no_wait: boolean

If true, the request for messages will end when received by the server