Interface Channel

Hierarchy

EventEmitter
- Channel
  - ConfirmChannel

Methods

ack

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

- Defined in node_modules/@types/amqplib/index.d.ts:56
Parameters
- message: Message
- Optional allUpTo: boolean
Returns void

ackAll

ackAll(): void

- Defined in node_modules/@types/amqplib/index.d.ts:57
Returns void

addListener

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

Inherited from events.EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

assertExchange

assertExchange(exchange: string, type: string, options?: AssertExchange): Bluebird<AssertExchange>

- Defined in node_modules/@types/amqplib/index.d.ts:40
Parameters
- exchange: string
- type: string
- Optional options: AssertExchange
Returns Bluebird<AssertExchange>

assertQueue

assertQueue(queue: string, options?: AssertQueue): Bluebird<AssertQueue>

- Defined in node_modules/@types/amqplib/index.d.ts:31
Parameters
- queue: string
- Optional options: AssertQueue
Returns Bluebird<AssertQueue>

bindExchange

bindExchange(destination: string, source: string, pattern: string, args?: any): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:45
Parameters
- destination: string
- source: string
- pattern: string
- Optional args: any
Returns Bluebird<Empty>

bindQueue

bindQueue(queue: string, source: string, pattern: string, args?: any): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:37
Parameters
- queue: string
- source: string
- pattern: string
- Optional args: any
Returns Bluebird<Empty>

cancel

cancel(consumerTag: string): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:53
Parameters
- consumerTag: string
Returns Bluebird<Empty>

checkExchange

checkExchange(exchange: string): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:41
Parameters
- exchange: string
Returns Bluebird<Empty>

checkQueue

checkQueue(queue: string): Bluebird<AssertQueue>

- Defined in node_modules/@types/amqplib/index.d.ts:32
Parameters
- queue: string
Returns Bluebird<AssertQueue>

close

close(): Bluebird<void>

- Defined in node_modules/@types/amqplib/index.d.ts:29
Returns Bluebird<void>

consume

consume(queue: string, onMessage: (msg: null | ConsumeMessage) => void, options?: Consume): Bluebird<Consume>

- Defined in node_modules/@types/amqplib/index.d.ts:51
Parameters
- queue: string
- onMessage: (msg: null | ConsumeMessage) => void
  - - (msg: null | ConsumeMessage): void
    - Parameters
      - msg: null | ConsumeMessage
      Returns void
- Optional options: Consume
Returns Bluebird<Consume>

deleteExchange

deleteExchange(exchange: string, options?: DeleteExchange): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:43
Parameters
- exchange: string
- Optional options: DeleteExchange
Returns Bluebird<Empty>

deleteQueue

deleteQueue(queue: string, options?: DeleteQueue): Bluebird<DeleteQueue>

- Defined in node_modules/@types/amqplib/index.d.ts:34
Parameters
- queue: string
- Optional options: DeleteQueue
Returns Bluebird<DeleteQueue>

emit

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

Inherited from events.EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from events.EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:76
Returns (string | symbol)[]

get

get(queue: string, options?: Get): Bluebird<false | GetMessage>

- Defined in node_modules/@types/amqplib/index.d.ts:54
Parameters
- queue: string
- Optional options: Get
Returns Bluebird<false | GetMessage>

getMaxListeners

getMaxListeners(): number

Inherited from events.EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from events.EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from events.EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:69
Parameters
- event: string | symbol
Returns Function[]

nack

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

- Defined in node_modules/@types/amqplib/index.d.ts:59
Parameters
- message: Message
- Optional allUpTo: boolean
- Optional requeue: boolean
Returns void

nackAll

nackAll(requeue?: boolean): void

- Defined in node_modules/@types/amqplib/index.d.ts:60
Parameters
- Optional requeue: boolean
Returns void

off

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

Inherited from events.EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

on

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

Inherited from events.EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

once

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

Inherited from events.EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

prefetch

prefetch(count: number, global?: boolean): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:63
Parameters
- count: number
- Optional global: boolean
Returns Bluebird<Empty>

prependListener

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

Inherited from events.EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:74
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

prependOnceListener

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

Inherited from events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

publish

publish(exchange: string, routingKey: string, content: Buffer, options?: Publish): boolean

- Defined in node_modules/@types/amqplib/index.d.ts:48
Parameters
- exchange: string
- routingKey: string
- content: Buffer
- Optional options: Publish
Returns boolean

purgeQueue

purgeQueue(queue: string): Bluebird<PurgeQueue>

- Defined in node_modules/@types/amqplib/index.d.ts:35
Parameters
- queue: string
Returns Bluebird<PurgeQueue>

rawListeners

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

Inherited from events.EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

recover

recover(): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:64
Returns Bluebird<Empty>

reject

reject(message: Message, requeue?: boolean): void

- Defined in node_modules/@types/amqplib/index.d.ts:61
Parameters
- message: Message
- Optional requeue: boolean
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): Channel

Inherited from events.EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- Optional event: string | symbol
Returns Channel

removeListener

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

Inherited from events.EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Channel

sendToQueue

sendToQueue(queue: string, content: Buffer, options?: Publish): boolean

- Defined in node_modules/@types/amqplib/index.d.ts:49
Parameters
- queue: string
- content: Buffer
- Optional options: Publish
Returns boolean

setMaxListeners

setMaxListeners(n: number): Channel

Inherited from events.EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- n: number
Returns Channel

unbindExchange

unbindExchange(destination: string, source: string, pattern: string, args?: any): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:46
Parameters
- destination: string
- source: string
- pattern: string
- Optional args: any
Returns Bluebird<Empty>

unbindQueue

unbindQueue(queue: string, source: string, pattern: string, args?: any): Bluebird<Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:38
Parameters
- queue: string
- source: string
- pattern: string
- Optional args: any
Returns Bluebird<Empty>

Generated using TypeDoc