haredo

    Interface QueueChain<T>

    interface QueueChain<T = unknown> {
        backoff(backoff: FailureBackoff): QueueSubscribeChain<T>;
        bindExchange(
            name: string,
            routingKey: string | string[],
            type: ExchangeType,
            exchangeParams?: ExchangeParams,
            exchangeArguments?: ExchangeArguments,
            bindingArguments?: BindingArguments,
        ): QueueSubscribeChain<T>;
        bindExchange<TEXCHANGE = unknown>(
            exchange: ExchangeInterface<TEXCHANGE>,
            routingKey: string | string[],
            bindingArguments?: BindingArguments,
        ): QueueSubscribeChain<Merge<T, TEXCHANGE>>;
        concurrency(count: number): QueueSubscribeChain<T>;
        confirm(): QueuePublishChain<T>;
        delete(options?: QueueDeleteOptions): Promise<void>;
        exclusive(exclusive?: boolean): QueueSubscribeChain<T>;
        expiration(milliseconds: number): QueuePublishChain<T>;
        json(autoSerialize?: boolean): this;
        noAck(noAck?: boolean): QueueSubscribeChain<T>;
        prefetch(count: number): QueueSubscribeChain<T>;
        priority(priority: number): QueuePublishChain<T>;
        publish(message: T): Promise<void>;
        purge(): Promise<void>;
        setHeader(key: string, value: string | number): QueuePublishChain<T>;
        setPublishArgument<K extends keyof AMQPProperties>(
            key: K,
            value: AMQPProperties[K],
        ): QueuePublishChain<T>;
        setup(): Promise<void>;
        skipSetup(options?: boolean | SkipSetupOptions): this;
        streamOffset(offset: StreamOffset): QueueSubscribeChain<T>;
        subscribe(callback: SubscribeCallback<T>): Promise<HaredoConsumer>;
        type(type: string): QueuePublishChain<T>;
        unbindExchange(
            name: string,
            routingKey: string | string[],
            bindingArguments?: BindingArguments,
        ): Promise<void>;
        unbindExchange(
            name: ExchangeInterface,
            routingKey: string | string[],
            bindingArguments?: BindingArguments,
        ): Promise<void>;
        use(...middleware: Middleware<T>[]): QueueSubscribeChain<T>;
    }

    Type Parameters

    • T = unknown

    Hierarchy (View Summary, Expand)

    Index

    Methods

    backoff bindExchange concurrency confirm delete exclusive expiration json noAck prefetch priority publish purge setHeader setPublishArgument setup skipSetup streamOffset subscribe type unbindExchange use

    Methods

    • Always serialize messages as JSON. This will make the publish method always serialize the message as JSON before sending it to the broker. The subscribe method will always deserialize the message as JSON before passing it to the callback.

      Parameters

      • OptionalautoSerialize: boolean

      Returns this

    • Send a message to the queue. Unless .json(false) has been called the message will be serialized as JSON before being sent to the broker.

      Parameters

      • message: T

      Returns Promise<void>

    • Set the offset to start reading from. This will only work with streams The possible values are:

      • 'first' - Start reading from the first message in the stream
      • 'last' - Start reading from the last message in the stream
      • 'next' - Start reading from the next message in the stream
      • number - Start reading from the message with the given sequence number
      • Interval - ie '7d' | '1h' | '30m' - Start reading from the message that was published the given interval ago
      • Date - Start reading from the message that was published at the given date

      When using timestamp based offsets You might still get messages that were published before the given timestamp.

      Parameters

      Returns QueueSubscribeChain<T>

    • Add middleware to the chain. Middleware will be called in the order they are added. Middleware can be used to modify the message before it is passed to the callback. Middleware can also be used to ack/nack the message.

      Middleware is invoked with the message and a function that returns a promise for the next item in the callback stack. If you don't call it and don't ack/nack the message then it will be called for you.

      Parameters

      Returns QueueSubscribeChain<T>

    Settings

    Member Visibility

    On This Page

    Methods
    MMNEPVFCICPMFPCPTTAAATR