Interface NatsConnection


  • NatsConnection


info?: ServerInfo

ServerInfo to the currently connected server or undefined

services: ServicesAPI


  • Close will close the connection to the server. This call will terminate all pending requests and subscriptions. The returned promise resolves when the connection closes.

    Returns Promise<void>

  • Returns a promise that can be used to monitor if the client closes. The promise can resolve an Error if the reason for the close was an error. Note that the promise doesn't reject, but rather resolves to the error if there was one.

    Returns Promise<void | Error>

  • Initiates a drain on the connection and returns a promise that resolves when the drain completes and the connection closes.

    Drain is an ordered shutdown of the client. Instead of abruptly closing the client, subscriptions are drained, that is messages not yet processed by a subscription are handled before the subscription is closed. After subscriptions are drained it is not possible to create a new subscription. Then all pending outbound messages are sent to the server. Finally, the connection is closed.

    Returns Promise<void>

  • Returns a Promise that resolves when the client receives a reply from the server. Use of this API is not necessary by clients.

    Returns Promise<void>

  • Returns the hostport of the server the client is connected to.

    Returns string

  • Returns true if the client is closed.

    Returns boolean

  • Returns true if the client is draining.

    Returns boolean

  • Publishes the specified data to the specified subject.


    • subject: string
    • Optional data: Uint8Array
    • Optional options: PublishOptions

    Returns void

  • Publishes a request with specified data in the specified subject expecting a response before timeout milliseconds. The api returns a Promise that resolves when the first response to the request is received. If there are no responders (a subscription) listening on the request subject, the request will fail as soon as the server processes it.


    • subject: string
    • Optional data: Uint8Array
    • Optional opts: RequestOptions

    Returns Promise<Msg>

  • Publishes a request expecting multiple responses back. Several strategies to determine when the request should stop gathering responses.


    Returns Promise<QueuedIterator<Msg>>

  • Returns

    the number of milliseconds it took for a flush.

    Returns Promise<number>

  • Returns some metrics such as the number of messages and bytes sent and recieved by the client.

    Returns Stats

  • Returns an async iterator of Status that may be useful in understanding when the client looses a connection, or reconnects, or receives an update from the cluster among other things.


    an AsyncIterable

    Returns AsyncIterable<Status>

Generated using TypeDoc