@nats-io/jetstream
    Preparing search index...

    Type Alias JetStreamPublishOptions

    Options for messages published to JetStream

    type JetStreamPublishOptions = {
        expect: Partial<
            {
                lastMsgID: string;
                lastSequence: number;
                lastSubjectSequence: number;
                streamName: string;
            },
        >;
        headers: MsgHdrs;
        msgID: string;
        retries?: number;
        timeout: number;
    }
    Index

    Properties

    expect headers msgID retries? timeout

    Properties

    expect: Partial<
        {
            lastMsgID: string;
            lastSequence: number;
            lastSubjectSequence: number;
            streamName: string;
        },
    >

    Set of constraints that when specified are verified by the server. If the constraint(s) doesn't match, the server will reject the message. These settings allow you to implement deduplication and consistency strategies.

    headers: MsgHdrs

    Headers associated with the message. You can create an instance of MsgHdrs with the headers() function.

    msgID: string

    A string identifier used to detect duplicate published messages. If the msgID is reused within the stream's duplicate_window, the message will be rejected by the stream, and the PubAck will mark it as a duplicate.

    retries?: number

    Continue to attempt to publish if the publish fails due to a no responders error. Default is 1.

    timeout: number

    The number of milliseconds to wait for the PubAck

    Settings

    Member Visibility

    On This Page

    Properties