Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CarrotMQ

CarrotMQ

extends

EventEmitter

Hierarchy

  • EventEmitter
    • CarrotMQ

Index

Constructors

Properties

Methods

Constructors

constructor

  • constructor

    Parameters

    • uri: string | Connect

      amqp url

    • Default value config: IConfig = defaultConfig

    Returns CarrotMQ

Properties

appId

appId: string

channels

channels: Set<Channel> = new Set<Channel>()

config

config: IConfig

connection

connection: Connection

Private consumers

consumers: Map<string, Set<IConsumer>> = new Map<string, Set<IConsumer>>()

decodeContent

decodeContent: decodeContent = decodeContent

isConnecting

isConnecting: boolean = false

Private isFirstConnection

isFirstConnection: boolean = true

makeContent

makeContent: MakeContentFunction = makeContent

manualClose

manualClose: boolean

ready

ready: boolean

Private readyPromise

readyPromise: Promise<void>

Private rpcListener

rpcListener: Map<string, Function> = new Map<string, Function>()

Private rpcQueues

rpcQueues: Set<string> = new Set<string>()

uri

uri: string | Connect

amqp url

Static captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private addQueueConsumer

  • addQueueConsumer(queue: string, consumer: IConsumer): void

Private awaitReady

  • awaitReady(): Promise<void>

close

  • close(): Bluebird<void>

connect

  • connect(): Promise<Connection>

  • connect to rabbitmq, auto call when construct,or can be called manually when need reconnect

    Returns Promise<Connection>

createChannel

  • createChannel(reason?: string): Promise<Channel>

  • get raw amqplib channel

    Parameters

    • Optional reason: string

    Returns Promise<Channel>

createConfirmChannel

  • createConfirmChannel(): Promise<ConfirmChannel>

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<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[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

publish

  • publish(exchange: string, routingKey: string, message: MessageType, options?: Publish): Promise<void>

  • publish into the exchange

    Parameters

    • exchange: string

      exchange name

    • routingKey: string

      routingKey

    • message: MessageType
    • Default value options: Publish = {}

    Returns Promise<void>

queue

  • queue(queue: string, consumer: IConsumer, opts?: AssertQueue): Promise<object>

  • attach a consumer on the queue

    Parameters

    • queue: string

      queue name

    • consumer: IConsumer

      consumer function

    • Optional opts: AssertQueue

    Returns Promise<object>

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private removeQueueConsumer

  • removeQueueConsumer(queue: string, consumer: IConsumer): void

Private restoreConsumer

  • restoreConsumer(): Promise<void>

rpc

rpcExchange

  • rpcExchange(exchange: string, routingKey: string, message: MessageType, options?: Publish): Promise<IRPCResult>

  • rpc over exchange

    Parameters

    • exchange: string

      exchange name

    • routingKey: string

      routing key

    • message: MessageType
    • Default value options: Publish = {}

    Returns Promise<IRPCResult>

sendToQueue

  • sendToQueue(queue: string, message: MessageType, options?: Publish & object): Promise<void>

  • send message to the queue

    Parameters

    • queue: string

      queue name

    • message: MessageType

      object=>JSON.stringify string=>Buffer.from

    • Default value options: Publish & object = {}

    Returns Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

Generated using TypeDoc