Interface Publisher

See

Connection#createPublisher()

The underlying Channel is lazily created the first time a message is published.

Example

const pub = rabbit.createPublisher({
  confirm: true,
  exchanges: [{exchange: 'user', type: 'topic'}]
})

await pub.send({exchange: 'user', routingKey: 'user.create'}, userInfo)

await pub.close()
interface Publisher {
    close(): Promise<void>;
    on(name, cb): Publisher;
    on(name, cb): Publisher;
    publish(envelope, body): Promise<void>;
    send(envelope, body): Promise<void>;
    send(queue, body): Promise<void>;
}

Hierarchy

  • EventEmitter
    • Publisher

Methods

close on publish send

Methods

close

  • close(): Promise<void>

  • Close the underlying channel

    Returns Promise<void>

on

  • on(name, cb): Publisher

  • An undeliverable message was published with the "immediate" flag set, or an unroutable message published with the "mandatory" flag set. The reply code and text provide information about the reason that the message was undeliverable.

    Parameters

    • name: "basic.return"
    • cb: ((msg) => void)

    Returns Publisher

  • on(name, cb): Publisher

  • See maxAttempts. Emitted each time a failed publish will be retried.

    Parameters

    • name: "retry"
    • cb: ((err, envelope, body) => void)
        • (err, envelope, body): void

        • Parameters

          Returns void

    Returns Publisher

publish

send

  • send(envelope, body): Promise<void>

  • This method publishes a message to a specific exchange. The message will be routed to queues as defined by the exchange configuration.

    If the body is a string then it will be serialized with contentType='text/plain'. If body is an object then it will be serialized with contentType='application/json'. Buffer objects are unchanged.

    If publisher-confirms are enabled, then this will resolve when the acknowledgement is received. Otherwise this will resolve after writing to the TCP socket, which is usually immediate. Note that if you keep publishing while the connection is blocked (see :BLOCKED | Connection#on('connection.blocked')) then the TCP socket buffer will eventually fill and this method will no longer resolve immediately.

    Parameters

    Returns Promise<void>

  • send(queue, body): Promise<void>

  • Send directly to a queue. Same as send({routingKey: queue}, body)

    Parameters

    • queue: string
    • body: any

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc