Interface Channel

Hierarchy

<internal>.EventEmitter
- Channel
  - <internal>.ConfirmChannel

Properties

connection

connection: <internal>.Connection

Methods

close

close(): Promise<void>

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

assertQueue

assertQueue(queue: string, options?: <internal>.AssertQueue): Promise<<internal>.AssertQueue>

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

checkQueue

checkQueue(queue: string): Promise<<internal>.AssertQueue>

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

deleteQueue

deleteQueue(queue: string, options?: <internal>.DeleteQueue): Promise<<internal>.DeleteQueue>

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

purgeQueue

purgeQueue(queue: string): Promise<<internal>.PurgeQueue>

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

bindQueue

bindQueue(queue: string, source: string, pattern: string, args?: any): Promise<<internal>.Empty>

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

unbindQueue

unbindQueue(queue: string, source: string, pattern: string, args?: any): Promise<<internal>.Empty>

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

assertExchange

assertExchange(exchange: string, type: string, options?: <internal>.AssertExchange): Promise<<internal>.AssertExchange>

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

checkExchange

checkExchange(exchange: string): Promise<<internal>.Empty>

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

deleteExchange

deleteExchange(exchange: string, options?: <internal>.DeleteExchange): Promise<<internal>.Empty>

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

bindExchange

bindExchange(destination: string, source: string, pattern: string, args?: any): Promise<<internal>.Empty>

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

unbindExchange

unbindExchange(destination: string, source: string, pattern: string, args?: any): Promise<<internal>.Empty>

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

publish

publish(exchange: string, routingKey: string, content: <internal>.Buffer, options?: <internal>.Publish): boolean

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

sendToQueue

sendToQueue(queue: string, content: <internal>.Buffer, options?: <internal>.Publish): boolean

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

consume

consume(queue: string, onMessage: ((msg: <internal>.ConsumeMessage) => void), options?: <internal>.Consume): Promise<<internal>.Consume>

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

cancel

cancel(consumerTag: string): Promise<<internal>.Empty>

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

get

get(queue: string, options?: <internal>.Get): Promise<false | <internal>.GetMessage>

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

ack

ack(message: <internal>.Message, allUpTo?: boolean): void

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

ackAll

ackAll(): void

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

nack

nack(message: <internal>.Message, allUpTo?: boolean, requeue?: boolean): void

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

nackAll

nackAll(requeue?: boolean): void

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

reject

reject(message: <internal>.Message, requeue?: boolean): void

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

prefetch

prefetch(count: number, global?: boolean): Promise<<internal>.Empty>

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

recover

recover(): Promise<<internal>.Empty>

- Defined in node_modules/@types/amqplib/index.d.ts:65
Returns Promise<<internal>.Empty>

addListener

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

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

on

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

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

once

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

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

removeListener

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

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

off

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): <internal>.Channel

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns <internal>.Channel

setMaxListeners

setMaxListeners(n: number): <internal>.Channel

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns <internal>.Channel

getMaxListeners

getMaxListeners(): number

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

listeners

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

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

rawListeners

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

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

emit

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

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:741
Parameters
- type: string | symbol
Returns number

prependListener

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

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

prependOnceListener

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

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

eventNames

eventNames(): (string | symbol)[]

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

Generated using TypeDoc