Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AMQPClient

Hierarchy

  • Socket
    • AMQPClient

Index

Properties

Readonly bufferSize

bufferSize: number
deprecated

since v14.6.0 - Use writableLength instead.

Readonly bytesRead

bytesRead: number

Readonly bytesWritten

bytesWritten: number

Readonly connecting

connecting: boolean

Readonly destroyed

destroyed: boolean

Readonly localAddress

localAddress: string

Readonly localPort

localPort: number

readable

readable: boolean

Readonly readableEncoding

readableEncoding: BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Optional Readonly remoteAddress

remoteAddress: string

Optional Readonly remoteFamily

remoteFamily: string

Optional Readonly remotePort

remotePort: number

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>
  • Returns AsyncIterableIterator<any>

Optional _construct

  • _construct(callback: (error?: Error) => void): void
  • Parameters

    • callback: (error?: Error) => void
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

_destroy

  • _destroy(error: Error, callback: (error: Error) => void): void
  • Parameters

    • error: Error
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

_final

  • _final(callback: (error?: Error) => void): void
  • Parameters

    • callback: (error?: Error) => void
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error) => void): void
  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: (error?: Error) => void
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: Error) => void): void
  • Parameters

    • chunks: { chunk: any; encoding: BufferEncoding }[]
    • callback: (error?: Error) => void
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

addListener

  • addListener(event: string, listener: (...args: any[]) => void): AMQPClient
  • addListener(event: "close", listener: (had_error: boolean) => void): AMQPClient
  • addListener(event: "connect", listener: () => void): AMQPClient
  • addListener(event: "data", listener: (data: Buffer) => void): AMQPClient
  • addListener(event: "drain", listener: () => void): AMQPClient
  • addListener(event: "end", listener: () => void): AMQPClient
  • addListener(event: "error", listener: (err: Error) => void): AMQPClient
  • addListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): AMQPClient
  • addListener(event: "timeout", listener: () => void): AMQPClient
  • events.EventEmitter

    1. close
    2. connect
    3. data
    4. drain
    5. end
    6. error
    7. lookup
    8. timeout

    Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "close"
    • listener: (had_error: boolean) => void
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (data: Buffer) => void
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "lookup"
    • listener: (err: Error, address: string, family: string | number, host: string) => void
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

address

  • address(): {} | AddressInfo
  • Returns {} | AddressInfo

connect

  • connect(options: SocketConnectOpts, connectionListener?: () => void): AMQPClient
  • connect(port: number, host: string, connectionListener?: () => void): AMQPClient
  • connect(port: number, connectionListener?: () => void): AMQPClient
  • connect(path: string, connectionListener?: () => void): AMQPClient
  • Parameters

    • options: SocketConnectOpts
    • Optional connectionListener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • port: number
    • host: string
    • Optional connectionListener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • port: number
    • Optional connectionListener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • path: string
    • Optional connectionListener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

cork

  • cork(): void
  • Returns void

destroy

  • destroy(error?: Error): void
  • Parameters

    • Optional error: Error

    Returns void

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close", had_error: boolean): boolean
  • emit(event: "connect"): boolean
  • emit(event: "data", data: Buffer): boolean
  • emit(event: "drain"): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean
  • emit(event: "timeout"): boolean
  • Parameters

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

    Returns boolean

  • Parameters

    • event: "close"
    • had_error: boolean

    Returns boolean

  • Parameters

    • event: "connect"

    Returns boolean

  • Parameters

    • event: "data"
    • data: Buffer

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "lookup"
    • err: Error
    • address: string
    • family: string | number
    • host: string

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

end

  • end(cb?: () => void): void
  • end(buffer: string | Uint8Array, cb?: () => void): void
  • end(str: string | Uint8Array, encoding?: BufferEncoding, cb?: () => void): void
  • Parameters

    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void
        • Returns void

    Returns void

eventNames

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

exchange

getMaxListeners

  • getMaxListeners(): number
  • Returns number

isPaused

  • isPaused(): boolean
  • Returns boolean

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: (...args: any[]) => void): AMQPClient
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

on

  • on(event: string, listener: (...args: any[]) => void): AMQPClient
  • on(event: "close", listener: (had_error: boolean) => void): AMQPClient
  • on(event: "connect", listener: () => void): AMQPClient
  • on(event: "data", listener: (data: Buffer) => void): AMQPClient
  • on(event: "drain", listener: () => void): AMQPClient
  • on(event: "end", listener: () => void): AMQPClient
  • on(event: "error", listener: (err: Error) => void): AMQPClient
  • on(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): AMQPClient
  • on(event: "timeout", listener: () => void): AMQPClient
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "close"
    • listener: (had_error: boolean) => void
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (data: Buffer) => void
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "lookup"
    • listener: (err: Error, address: string, family: string | number, host: string) => void
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

once

  • once(event: string, listener: (...args: any[]) => void): AMQPClient
  • once(event: "close", listener: (had_error: boolean) => void): AMQPClient
  • once(event: "connect", listener: () => void): AMQPClient
  • once(event: "data", listener: (data: Buffer) => void): AMQPClient
  • once(event: "drain", listener: () => void): AMQPClient
  • once(event: "end", listener: () => void): AMQPClient
  • once(event: "error", listener: (err: Error) => void): AMQPClient
  • once(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): AMQPClient
  • once(event: "timeout", listener: () => void): AMQPClient
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "close"
    • listener: (had_error: boolean) => void
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (data: Buffer) => void
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "lookup"
    • listener: (err: Error, address: string, family: string | number, host: string) => void
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

pause

  • Returns AMQPClient

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T
  • Type parameters

    • T: WritableStream<T>

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: string, listener: (...args: any[]) => void): AMQPClient
  • prependListener(event: "close", listener: (had_error: boolean) => void): AMQPClient
  • prependListener(event: "connect", listener: () => void): AMQPClient
  • prependListener(event: "data", listener: (data: Buffer) => void): AMQPClient
  • prependListener(event: "drain", listener: () => void): AMQPClient
  • prependListener(event: "end", listener: () => void): AMQPClient
  • prependListener(event: "error", listener: (err: Error) => void): AMQPClient
  • prependListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): AMQPClient
  • prependListener(event: "timeout", listener: () => void): AMQPClient
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "close"
    • listener: (had_error: boolean) => void
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (data: Buffer) => void
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "lookup"
    • listener: (err: Error, address: string, family: string | number, host: string) => void
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

prependOnceListener

  • prependOnceListener(event: string, listener: (...args: any[]) => void): AMQPClient
  • prependOnceListener(event: "close", listener: (had_error: boolean) => void): AMQPClient
  • prependOnceListener(event: "connect", listener: () => void): AMQPClient
  • prependOnceListener(event: "data", listener: (data: Buffer) => void): AMQPClient
  • prependOnceListener(event: "drain", listener: () => void): AMQPClient
  • prependOnceListener(event: "end", listener: () => void): AMQPClient
  • prependOnceListener(event: "error", listener: (err: Error) => void): AMQPClient
  • prependOnceListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): AMQPClient
  • prependOnceListener(event: "timeout", listener: () => void): AMQPClient
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "close"
    • listener: (had_error: boolean) => void
        • (had_error: boolean): void
        • Parameters

          • had_error: boolean

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (data: Buffer) => void
        • (data: Buffer): void
        • Parameters

          • data: Buffer

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "lookup"
    • listener: (err: Error, address: string, family: string | number, host: string) => void
        • (err: Error, address: string, family: string | number, host: string): void
        • Parameters

          • err: Error
          • address: string
          • family: string | number
          • host: string

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

publish

  • publish(routingKey: string, body: any, options: {}, callback: (err?: boolean, msg?: string) => void): void
  • Parameters

    • routingKey: string
    • body: any
    • options: {}
    • callback: (err?: boolean, msg?: string) => void
        • (err?: boolean, msg?: string): void
        • Parameters

          • Optional err: boolean
          • Optional msg: string

          Returns void

    Returns void

push

  • push(chunk: any, encoding?: BufferEncoding): boolean
  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns boolean

queue

rawListeners

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

    • event: string | symbol

    Returns Function[]

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • Returns AMQPClient

removeAllListeners

  • removeAllListeners(event?: string | symbol): AMQPClient
  • Parameters

    • Optional event: string | symbol

    Returns AMQPClient

removeListener

  • removeListener(event: "close", listener: () => void): AMQPClient
  • removeListener(event: "data", listener: (chunk: any) => void): AMQPClient
  • removeListener(event: "end", listener: () => void): AMQPClient
  • removeListener(event: "error", listener: (err: Error) => void): AMQPClient
  • removeListener(event: "pause", listener: () => void): AMQPClient
  • removeListener(event: "readable", listener: () => void): AMQPClient
  • removeListener(event: "resume", listener: () => void): AMQPClient
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): AMQPClient
  • Parameters

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void
        • Parameters

          • chunk: any

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "error"
    • listener: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns AMQPClient

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void
        • Returns void

    Returns AMQPClient

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns AMQPClient

resume

  • Returns AMQPClient

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): AMQPClient
  • Parameters

    • encoding: BufferEncoding

    Returns AMQPClient

setEncoding

  • setEncoding(encoding?: BufferEncoding): AMQPClient
  • Parameters

    • Optional encoding: BufferEncoding

    Returns AMQPClient

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): AMQPClient
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns AMQPClient

setMaxListeners

  • Parameters

    • n: number

    Returns AMQPClient

setNoDelay

  • Parameters

    • Optional noDelay: boolean

    Returns AMQPClient

setTimeout

  • setTimeout(timeout: number, callback?: () => void): AMQPClient
  • Parameters

    • timeout: number
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns AMQPClient

uncork

  • uncork(): void
  • Returns void

unpipe

  • unpipe(destination?: WritableStream): AMQPClient
  • Parameters

    • Optional destination: WritableStream

    Returns AMQPClient

unref

  • Returns AMQPClient

unshift

  • unshift(chunk: any, encoding?: BufferEncoding): void
  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding

    Returns void

wrap

  • Parameters

    • oldStream: ReadableStream

    Returns AMQPClient

write

  • write(buffer: string | Uint8Array, cb?: (err?: Error) => void): boolean
  • write(str: string | Uint8Array, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean
  • Parameters

    • buffer: string | Uint8Array
    • Optional cb: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean

  • Parameters

    • str: string | Uint8Array
    • Optional encoding: BufferEncoding
    • Optional cb: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns boolean

Generated using TypeDoc