Class IMQClient

Class IMQClient - base abstract class for service clients.

Hierarchy

EventEmitter
- IMQClient
  - GeneratorClient
  - HelloClient

Index

Constructors

constructor

Properties

Constructors

constructor

new IMQClient(options?: Partial<IMQClientOptions>, serviceName?: undefined | string, name?: undefined | string): IMQClient

- Defined in src/IMQClient.ts:63
Class constructor

constructor

Parameters
- Optional options: Partial<IMQClientOptions>
- Optional serviceName: undefined | string
- Optional name: undefined | string
Returns IMQClient

Properties

id

id: number

name

name: string

options

options: IMQClientOptions

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:1050
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

describe

describe(delay?: IMQDelay): Promise<Description>

- Defined in src/IMQClient.ts:213
Returns service description metadata.

Parameters
- Optional delay: IMQDelay
Returns Promise<Description>

destroy

destroy(): Promise<void>

- Defined in src/IMQClient.ts:199
Destroys client

Returns Promise<void>

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:1062
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/index.d.ts:1063
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1059
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1064
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/index.d.ts:1060
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/index.d.ts:1056
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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:1051
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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:1052
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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:1053
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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:1054
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/index.d.ts:1061
Parameters
- event: string | symbol
Returns Function[]

Protected remoteCall

remoteCall<T>(...args: any[]): Promise<T>

- Defined in src/IMQClient.ts:118
Sends call to remote service method

access

protected

Type parameters
- T
Parameters
- Rest ...args: any[]
Returns Promise<T>

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/index.d.ts:1057
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:1055
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1058
Parameters
- n: number
Returns this

start

start(): Promise<void>

- Defined in src/IMQClient.ts:153
Initializes client work

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/IMQClient.ts:190
Stops client work

Returns Promise<void>

Static create

create(name: string, options?: Partial<IMQClientOptions>): Promise<any>

- Defined in src/IMQClient.ts:224
Creates client for a service with the given name

Parameters
- name: string
- Optional options: Partial<IMQClientOptions>
Returns Promise<any>

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1047
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number