AmqpConnectionManager | @types/amqp-connection-manager

Hierarchy

EventEmitter
- AmqpConnectionManager

Index

Methods

addListener

addListener(event: string, listener: (...args: any[]) => void): AmqpConnectionManager
addListener(event: "connect", listener: (arg: { connection: Connection; url: string }) => void): AmqpConnectionManager
addListener(event: "disconnect", listener: (arg: { err: Error }) => void): AmqpConnectionManager

Overrides EventEmitter.addListener
- Defined in amqp-connection-manager/index.d.ts:83
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.addListener
- Defined in amqp-connection-manager/index.d.ts:84
Parameters
- event: "connect"
- listener: (arg: { connection: Connection; url: string }) => void
  - - (arg: { connection: Connection; url: string }): void
    - Parameters
      - arg: { connection: Connection; url: string }
        
        connection: Connection
        
        url: string
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.addListener
- Defined in amqp-connection-manager/index.d.ts:85
Parameters
- event: "disconnect"
- listener: (arg: { err: Error }) => void
  - - (arg: { err: Error }): void
    - Parameters
      - arg: { err: Error }
        
        err: Error
      Returns void
Returns AmqpConnectionManager

close

close(): Promise<void>

- Defined in amqp-connection-manager/index.d.ts:117
Close this AmqpConnectionManager and free all associated resources.

Returns Promise<void>

createChannel

createChannel(opts?: CreateChannelOpts): ChannelWrapper

- Defined in amqp-connection-manager/index.d.ts:107
Create a new ChannelWrapper. This is a proxy for the actual channel (which may or may not exist at any moment, depending on whether or not we are currently connected.)

Parameters
- Optional opts: CreateChannelOpts
Returns ChannelWrapper

emit

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

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

eventNames

eventNames(): (string | symbol)[]

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node/events.d.ts:79
Returns number

isConnected

isConnected(): boolean

- Defined in amqp-connection-manager/index.d.ts:112
Returns true if the AmqpConnectionManager is connected to a broker, false otherwise.

Returns boolean

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

off

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

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

on

on(event: string, listener: (...args: any[]) => void): AmqpConnectionManager
on(event: "connect", listener: (arg: { connection: Connection; url: string }) => void): AmqpConnectionManager
on(event: "disconnect", listener: (arg: { err: Error }) => void): AmqpConnectionManager

Overrides EventEmitter.on
- Defined in amqp-connection-manager/index.d.ts:87
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.on
- Defined in amqp-connection-manager/index.d.ts:88
Parameters
- event: "connect"
- listener: (arg: { connection: Connection; url: string }) => void
  - - (arg: { connection: Connection; url: string }): void
    - Parameters
      - arg: { connection: Connection; url: string }
        
        connection: Connection
        
        url: string
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.on
- Defined in amqp-connection-manager/index.d.ts:89
Parameters
- event: "disconnect"
- listener: (arg: { err: Error }) => void
  - - (arg: { err: Error }): void
    - Parameters
      - arg: { err: Error }
        
        err: Error
      Returns void
Returns AmqpConnectionManager

once

once(event: string, listener: (...args: any[]) => void): AmqpConnectionManager
once(event: "connect", listener: (arg: { connection: Connection; url: string }) => void): AmqpConnectionManager
once(event: "disconnect", listener: (arg: { err: Error }) => void): AmqpConnectionManager

Overrides EventEmitter.once
- Defined in amqp-connection-manager/index.d.ts:91
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.once
- Defined in amqp-connection-manager/index.d.ts:92
Parameters
- event: "connect"
- listener: (arg: { connection: Connection; url: string }) => void
  - - (arg: { connection: Connection; url: string }): void
    - Parameters
      - arg: { connection: Connection; url: string }
        
        connection: Connection
        
        url: string
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.once
- Defined in amqp-connection-manager/index.d.ts:93
Parameters
- event: "disconnect"
- listener: (arg: { err: Error }) => void
  - - (arg: { err: Error }): void
    - Parameters
      - arg: { err: Error }
        
        err: Error
      Returns void
Returns AmqpConnectionManager

prependListener

prependListener(event: string, listener: (...args: any[]) => void): AmqpConnectionManager
prependListener(event: "connect", listener: (arg: { connection: Connection; url: string }) => void): AmqpConnectionManager
prependListener(event: "disconnect", listener: (arg: { err: Error }) => void): AmqpConnectionManager

Overrides EventEmitter.prependListener
- Defined in amqp-connection-manager/index.d.ts:95
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.prependListener
- Defined in amqp-connection-manager/index.d.ts:96
Parameters
- event: "connect"
- listener: (arg: { connection: Connection; url: string }) => void
  - - (arg: { connection: Connection; url: string }): void
    - Parameters
      - arg: { connection: Connection; url: string }
        
        connection: Connection
        
        url: string
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.prependListener
- Defined in amqp-connection-manager/index.d.ts:97
Parameters
- event: "disconnect"
- listener: (arg: { err: Error }) => void
  - - (arg: { err: Error }): void
    - Parameters
      - arg: { err: Error }
        
        err: Error
      Returns void
Returns AmqpConnectionManager

prependOnceListener

prependOnceListener(event: string, listener: (...args: any[]) => void): AmqpConnectionManager
prependOnceListener(event: "connect", listener: (arg: { connection: Connection; url: string }) => void): AmqpConnectionManager
prependOnceListener(event: "disconnect", listener: (arg: { err: Error }) => void): AmqpConnectionManager

Overrides EventEmitter.prependOnceListener
- Defined in amqp-connection-manager/index.d.ts:99
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.prependOnceListener
- Defined in amqp-connection-manager/index.d.ts:100
Parameters
- event: "connect"
- listener: (arg: { connection: Connection; url: string }) => void
  - - (arg: { connection: Connection; url: string }): void
    - Parameters
      - arg: { connection: Connection; url: string }
        
        connection: Connection
        
        url: string
      Returns void
Returns AmqpConnectionManager
Overrides EventEmitter.prependOnceListener
- Defined in amqp-connection-manager/index.d.ts:101
Parameters
- event: "disconnect"
- listener: (arg: { err: Error }) => void
  - - (arg: { err: Error }): void
    - Parameters
      - arg: { err: Error }
        
        err: Error
      Returns void
Returns AmqpConnectionManager

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): AmqpConnectionManager

Inherited from EventEmitter.removeAllListeners
- Defined in node/events.d.ts:77
Parameters
- Optional event: string | symbol
Returns AmqpConnectionManager

removeListener

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

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

setMaxListeners

setMaxListeners(n: number): AmqpConnectionManager

Inherited from EventEmitter.setMaxListeners
- Defined in node/events.d.ts:78
Parameters
- n: number
Returns AmqpConnectionManager

Hierarchy

Index

Methods

Methods

addListener

Parameters

event: string

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

Parameters

Rest ...args: any[]

Returns void

Returns AmqpConnectionManager

Parameters

event: "connect"

listener: (arg: { connection: Connection; url: string }) => void

Parameters

arg: { connection: Connection; url: string }

connection: Connection

url: string

Returns void

Returns AmqpConnectionManager

Parameters

event: "disconnect"

listener: (arg: { err: Error }) => void

Parameters

arg: { err: Error }

err: Error

Returns void

Returns AmqpConnectionManager

close

Returns Promise<void>

createChannel

Parameters

Optional opts: CreateChannelOpts

Returns ChannelWrapper

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

isConnected

Returns boolean

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns AmqpConnectionManager

on

Parameters

event: string

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

Parameters

Rest ...args: any[]

Returns void

Returns AmqpConnectionManager

Parameters

event: "connect"

listener: (arg: { connection: Connection; url: string }) => void

Parameters

arg: { connection: Connection; url: string }

connection: Connection

url: string

Returns void

Returns AmqpConnectionManager

Parameters