Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelWrapper

Hierarchy

  • EventEmitter
    • ChannelWrapper

Index

Methods

Methods

ack

  • ack(message: Message, allUpTo?: boolean): void
  • see

    amqplib

    Parameters

    • message: Message
    • Optional allUpTo: boolean

    Returns void

addListener

  • addListener(event: string, listener: (...args: any[]) => void): ChannelWrapper
  • addListener(event: "connect", listener: () => void): ChannelWrapper
  • addListener(event: "error", listener: (err: Error, info: { name: string }) => void): ChannelWrapper
  • addListener(event: "close", listener: () => void): ChannelWrapper

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "error"
    • listener: (err: Error, info: { name: string }) => void
        • (err: Error, info: { name: string }): void

        • Parameters

          • err: Error
          • info: { name: string }
            • name: string

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

addSetup

  • Adds a new 'setup handler'. setup(channel, [cb]) is a function to call when a new underlying channel is created - handy for asserting exchanges and queues exists, and whatnot. The channel object here is a ConfirmChannel from amqplib. The setup function should return a Promise (or optionally take a callback) - no messages will be sent until this Promise resolves. If there is a connection, setup() will be run immediately, and the addSetup Promise/callback won't resolve until setup is complete. Note that in this case, if the setup throws an error, no 'error' event will be emitted, since you can just handle the error here (although the setup will still be added for future reconnects, even if it throws an error.) Setup functions should, ideally, not throw errors, but if they do then the ChannelWrapper will emit an 'error' event.

    Parameters

    Returns Promise<void>

close

  • close(): Promise<void>

  • Close a channel, clean up resources associated with it.

    Returns Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

nack

  • nack(message: Message, allUpTo?: boolean, requeue?: boolean): void
  • see

    amqplib

    Parameters

    • message: Message
    • Optional allUpTo: boolean
    • Optional requeue: boolean

    Returns void

off

  • off(event: string | symbol, listener: (...args: any[]) => void): ChannelWrapper

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

on

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "error"
    • listener: (err: Error, info: { name: string }) => void
        • (err: Error, info: { name: string }): void

        • Parameters

          • err: Error
          • info: { name: string }
            • name: string

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

once

  • once(event: string, listener: (...args: any[]) => void): ChannelWrapper
  • once(event: "connect", listener: () => void): ChannelWrapper
  • once(event: "error", listener: (err: Error, info: { name: string }) => void): ChannelWrapper
  • once(event: "close", listener: () => void): ChannelWrapper

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "error"
    • listener: (err: Error, info: { name: string }) => void
        • (err: Error, info: { name: string }): void

        • Parameters

          • err: Error
          • info: { name: string }
            • name: string

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

prependListener

  • prependListener(event: string, listener: (...args: any[]) => void): ChannelWrapper
  • prependListener(event: "connect", listener: () => void): ChannelWrapper
  • prependListener(event: "error", listener: (err: Error, info: { name: string }) => void): ChannelWrapper
  • prependListener(event: "close", listener: () => void): ChannelWrapper

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "error"
    • listener: (err: Error, info: { name: string }) => void
        • (err: Error, info: { name: string }): void

        • Parameters

          • err: Error
          • info: { name: string }
            • name: string

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

prependOnceListener

  • prependOnceListener(event: string, listener: (...args: any[]) => void): ChannelWrapper
  • prependOnceListener(event: "connect", listener: () => void): ChannelWrapper
  • prependOnceListener(event: "error", listener: (err: Error, info: { name: string }) => void): ChannelWrapper
  • prependOnceListener(event: "close", listener: () => void): ChannelWrapper

  • Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "error"
    • listener: (err: Error, info: { name: string }) => void
        • (err: Error, info: { name: string }): void

        • Parameters

          • err: Error
          • info: { name: string }
            • name: string

          Returns void

    Returns ChannelWrapper

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns ChannelWrapper

publish

  • publish(exchange: string, routingKey: string, content: object | Buffer, options?: Publish, callback?: (err: any, ok: Empty) => void): Promise<void>
  • see

    amqplib

    Parameters

    • exchange: string
    • routingKey: string
    • content: object | Buffer
    • Optional options: Publish
    • Optional callback: (err: any, ok: Empty) => void
        • (err: any, ok: Empty): void

        • Parameters

          • err: any
          • ok: Empty

          Returns void

    Returns Promise<void>

queueLength

  • queueLength(): number

  • Returns a count of messages currently waiting to be sent to the underlying channel.

    Returns number

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns ChannelWrapper

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ChannelWrapper

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ChannelWrapper

removeSetup

  • Remove a setup function added with addSetup. If there is currently a connection, teardown(channel, [cb]) will be run immediately, and the returned Promise will not resolve until it completes.

    Parameters

    Returns Promise<void>

sendToQueue

  • sendToQueue(queue: string, content: object | Buffer, options?: Publish, callback?: (err: any, ok: Empty) => void): Promise<void>
  • see

    amqplib

    Parameters

    • queue: string
    • content: object | Buffer
    • Optional options: Publish
    • Optional callback: (err: any, ok: Empty) => void
        • (err: any, ok: Empty): void

        • Parameters

          • err: any
          • ok: Empty

          Returns void

    Returns Promise<void>

setMaxListeners

  • Parameters

    • n: number

    Returns ChannelWrapper

waitForConnect

  • waitForConnect(): Promise<void>

  • Returns a Promise which resolves when this channel next connects.

    Returns Promise<void>

Generated using TypeDoc