Class IMQClientAbstract

constructor

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

  Class constructor

  Parameters

  • Optionaloptions: Partial<IMQClientOptions>
  • OptionalserviceName: string
  • Optionalname: string

  Returns IMQClient

ReadonlyhostName

Readonlyid

Readonlyname

Readonlyoptions

ReadonlyqueueName

ReadonlyserviceName

broadcast

• broadcast(payload: JsonObject): Promise<void>

  Broadcasts given payload to all other service clients subscribed. So this is like client-to-clients publishing.

  Parameters

  • payload: JsonObject

  Returns Promise<void>

describe

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

  Returns service description metadata.

  Parameters

  • Optionaldelay: IMQDelay

  Returns Promise<Description>

destroy

• destroy(): Promise<void>

  Destroys client

  Returns Promise<void>

start

• start(): Promise<void>

  Initializes client work

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stops client work

  Returns Promise<void>

subscribe

• subscribe(handler: (data: JsonObject) => any): Promise<void>

  Adds subscription to service event channel

  Parameters

  • handler: (data: JsonObject) => any

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

  Destroys subscription channel to service

  Returns Promise<void>

Staticcreate

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

  Creates client for a service with the given name

  Parameters

  • name: string
  • Optionaloptions: Partial<IMQClientOptions>

  Returns Promise<any>