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

    Interface RequestManyOptions

    interface RequestManyOptions {
        headers?: MsgHdrs;
        maxMessages?: number;
        maxWait: number;
        noMux?: boolean;
        stall?: number;
        strategy: RequestStrategy | SentinelFn | SentinelFn[];
        timeout?: number;
        traceDestination?: string;
        traceOnly?: boolean;
    }

    Hierarchy

    • TraceOptions
      • RequestManyOptions
    Index
    headers?: MsgHdrs
    maxMessages?: number
    maxWait: number

    The upper bound in millis for the request, it ends when this expires. Defaults to 1000. Infinity removes the bound, the request then ends only by the strategy, stall, an error or stopping the iterator.

    noMux?: boolean
    stall?: number

    If set, after each response the request ends if no other response arrives within this many millis. Works with any strategy, and never extends the request past maxWait. A stall of 0 or less, or not less than maxWait, is ignored. The "stall" strategy defaults to 300, which is also used if its stall is 0 or less.

    Ends the request early, before maxWait. A SentinelFn or an array of them (run in order, the first that doesn't return true ends the request) can implement custom protocols.

    timeout?: number

    If set, the first response must arrive within this many millis, otherwise the request fails with a TimeoutError. It doesn't end the request once responses arrive. Must be less than maxWait.

    traceDestination?: string

    If set, the server will send events representing the flow of the message as it moves through the system to this subject.

    traceOnly?: boolean

    If true, the message will NOT be delivered, and instead will just generate trace information. Note that in the context of requests, this means the service will not be triggered so the operation will timeout or return no responses.