Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Channel<Data>

Type parameters

  • Data

Hierarchy

  • Channel

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected channel

channel: BaseChannel

Protected exchanges

exchanges: Exchange<Data>[] = []

logger

logger: LoggerInstance

options

options: ChannelOptions<Data>

Protected serializer

serializer: Serializer = new Serializer()

Methods

ack

  • ack(message: AMQPMessage, allUpTo?: boolean): Promise<void>

  • Parameters

    • message: AMQPMessage
    • Optional allUpTo: boolean

    Returns Promise<void>

assertQueue

  • assertQueue(name: string, options: AMQPOptions.AssertQueue): Promise<AssertQueue>

  • Parameters

    • name: string
    • options: AMQPOptions.AssertQueue

    Returns Promise<AssertQueue>

bindQueue

  • bindQueue(queueName: string, exchangeName: string, route: string): Promise<Empty>

  • Parameters

    • queueName: string
    • exchangeName: string
    • route: string

    Returns Promise<Empty>

close

  • close(): Promise<void>

consume

  • consume(queue: string, onMessage: (content: any, msg: AMQPMessage) => any, options?: AMQPOptions.Consume): Promise<Consume>

  • Parameters

    • queue: string
    • onMessage: (content: any, msg: AMQPMessage) => any
        • (content: any, msg: AMQPMessage): any

        • Parameters

          • content: any
          • msg: AMQPMessage

          Returns any

    • Optional options: AMQPOptions.Consume

    Returns Promise<Consume>

exchange

nack

  • nack(message: AMQPMessage, allUpTo?: boolean, requeue?: boolean): Promise<Timeout>

  • Parameters

    • message: AMQPMessage
    • Optional allUpTo: boolean
    • Optional requeue: boolean

    Returns Promise<Timeout>

prefetch

  • prefetch(num: number, global?: boolean): Promise<Empty>

  • Parameters

    • num: number
    • Optional global: boolean

    Returns Promise<Empty>

publish

  • publish(name: string, route: string, data: any, options?: AMQPOptions.Publish): Promise<boolean>

  • Parameters

    • name: string
    • route: string
    • data: any
    • Optional options: AMQPOptions.Publish

    Returns Promise<boolean>

queue

  • Gets a queue ready for publishing and consuming.

    Parameters

    Returns Promise<Queue<Data>>

sendToQueue

  • sendToQueue(name: string, data: any, options?: AMQPOptions.Publish): Promise<boolean>

  • Parameters

    • name: string
    • data: any
    • Optional options: AMQPOptions.Publish

    Returns Promise<boolean>

Static from

Generated using TypeDoc