haredo

    Interface KnownQueueArguments

    interface KnownQueueArguments {
        "message-ttl"?: number;
        "x-dead-letter-exchange"?: string;
        "x-dead-letter-routing-key"?: string;
        "x-delivery-limit"?: number;
        "x-expires"?: number;
        "x-max-age"?:
            | `${number}Y`
            | `${number}M`
            | `${number}D`
            | `${number}h`
            | `${number}m`
            | `${number}s`;
        "x-max-length"?: number;
        "x-max-length-bytes"?: number;
        "x-max-priority"?: number;
        "x-overflow"?: XOverflow;
        "x-queue-type"?: "classic"
        | "quorum"
        | "stream";
        "x-single-active-consumer"?: boolean;
        "x-stream-max-segment-size-bytes"?: number;
    }
    Index

    Properties

    message-ttl? x-dead-letter-exchange? x-dead-letter-routing-key? x-delivery-limit? x-expires? x-max-age? x-max-length? x-max-length-bytes? x-max-priority? x-overflow? x-queue-type? x-single-active-consumer? x-stream-max-segment-size-bytes?

    Properties

    "message-ttl"?: number

    Maximum TTL for messages in the queue.

    "x-dead-letter-exchange"?: string

    In case of messages being rejected or dead, they will be sent to the specified exchange.

    "x-dead-letter-routing-key"?: string

    When paired with x-dead-letter-exchange this will be the routing key for dead letter messages.

    "x-delivery-limit"?: number

    Maximum number of times a message in the queue will be delivered. Only applicable to quorum queues.

    "x-expires"?: number

    Delete the queue after the given time in milliseconds of disuse.

    "x-max-age"?:
        | `${number}Y`
        | `${number}M`
        | `${number}D`
        | `${number}h`
        | `${number}m`
        | `${number}s`

    Maximum age of the messages in the stream. Retention is only evaluated when a new segment is added to the stream

    "x-max-length"?: number

    Maximum length of the queue. Overflow behavior is set with x-overflow.

    "x-max-length-bytes"?: number

    Maximum length of the queue in bytes. Overflow behavior is set with x-overflow.

    "x-max-priority"?: number

    Maximum priority of the messages in the queue. Larger numbers indicate higher priority.

    "x-overflow"?: XOverflow

    Overflow behavior for x-max-length and x-max-length-bytes.

    'drop-head'
    "x-queue-type"?: "classic" | "quorum" | "stream"

    The type of the queue.

    "x-single-active-consumer"?: boolean

    Set the queue to have a single active consumer. See https://www.rabbitmq.com/consumers.html#single-active-consumer

    "x-stream-max-segment-size-bytes"?: number

    A stream is divided up into fixed size segment files on disk. This setting controls the size of these. Default: (500000000 bytes).

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR