Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConfirmChannel

Hierarchy

Index

Methods

Methods

ack

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

  • Parameters

    • message: Message
    • Optional allUpTo: boolean

    Returns void

ackAll

  • ackAll(): void

  • Returns void

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

assertExchange

assertQueue

bindExchange

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

  • 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>

  • Parameters

    • queue: string
    • source: string
    • pattern: string
    • Optional args: any

    Returns Bluebird<Empty>

cancel

  • cancel(consumerTag: string): Bluebird<Empty>

  • Parameters

    • consumerTag: string

    Returns Bluebird<Empty>

checkExchange

  • checkExchange(exchange: string): Bluebird<Empty>

  • Parameters

    • exchange: string

    Returns Bluebird<Empty>

checkQueue

  • Parameters

    • queue: string

    Returns Bluebird<AssertQueue>

close

  • close(): Bluebird<void>

  • Returns Bluebird<void>

consume

deleteExchange

deleteQueue

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

get

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

  • Parameters

    • queue: string
    • Optional options: Get

    Returns Bluebird<false | GetMessage>

getMaxListeners

  • getMaxListeners(): 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

  • Parameters

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

    Returns void

nackAll

  • nackAll(requeue?: boolean): void

  • Parameters

    • Optional requeue: boolean

    Returns void

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

prefetch

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

  • Parameters

    • count: number
    • Optional global: boolean

    Returns Bluebird<Empty>

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

publish

  • publish(exchange: string, routingKey: string, content: Buffer, options?: Publish, callback?: (err: any, ok: Empty) => void): boolean

  • Parameters

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

        • Parameters

          Returns void

    Returns boolean

purgeQueue

  • Parameters

    • queue: string

    Returns Bluebird<PurgeQueue>

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

recover

  • recover(): Bluebird<Empty>

  • Returns Bluebird<Empty>

reject

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

  • Parameters

    • message: Message
    • Optional requeue: boolean

    Returns void

removeAllListeners

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ConfirmChannel

sendToQueue

  • sendToQueue(queue: string, content: Buffer, options?: Publish, callback?: (err: any, ok: Empty) => void): boolean

  • Parameters

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

        • Parameters

          Returns void

    Returns boolean

setMaxListeners

unbindExchange

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

  • 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>

  • Parameters

    • queue: string
    • source: string
    • pattern: string
    • Optional args: any

    Returns Bluebird<Empty>

waitForConfirms

  • waitForConfirms(): Bluebird<void>

  • Returns Bluebird<void>

Generated using TypeDoc