Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NatsTransport

NATS transport.

Hierarchy

  • NatsTransport

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _client

_client: Client

Private _closeHandler

_closeHandler: Function

Private Optional _options

_options: any

Methods

close

  • close(): void

handle

  • handle(route: string, group: string, callback: Function): void

  • Transport handle.

    Parameters

    • route: string
    • group: string
    • callback: Function

    Returns void

listen

  • listen(callback: Function): void

onClose

  • onClose(callback: function): void

  • Connection closed handler

    Parameters

    • callback: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

publish

  • publish(topic: string, message: any): void

  • Publish to a topic.

    Parameters

    • topic: string
    • message: any

    Returns void

request

  • request(route: string, payload: any, callback: Function, timeout?: number): void

  • Client request. Nats client implements this pattern out of the box. Publish a request with an implicit inbox listener as the response. This should be treated as a subscription.

    Parameters

    • route: string
    • payload: any
    • callback: Function
    • Default value timeout: number = 200

    Returns void

subscribe

  • subscribe(topic: string, group: string, callback: Function): number

  • Subscribe to a topic.

    Parameters

    • topic: string
    • group: string
    • callback: Function

    Returns number

unsubscribe

  • unsubscribe(sid: number, max?: number): void

  • Unsubscribe from a topic.

    Parameters

    • sid: number
    • Optional max: number

    Returns void

Generated using TypeDoc