Optional authenticatorOptional debugWhen set to true the client will print protocol messages that it receives
or sends to the server.
Optional ignoreBy default, NATS clients will abort reconnect if they fail authentication twice in a row with the same error, regardless of the reconnect policy. This option should be used with care as it will disable this behaviour when true
Optional ignoreWhen set to true, cluster information gossiped by the nats-server will not augment the lists of server(s) known by the client.
Optional inboxA string prefix (must be a valid subject prefix) prepended to inboxes generated by client. This allows a client with limited subject permissions to specify a subject where requests can deliver responses.
Optional maxSets the maximum count of ping commands that can be awaiting a response before rasing a stale connection status StaleConnection notification status and initiating a reconnect.
pingInterval
Optional maxSets the maximum count of per-server reconnect attempts before giving up.
Set to -1 to never give up.
10
Optional nameSets the client name. When set, the server monitoring pages will display this name when referring to this client.
Optional noWhen true, the client will not augment timeout and other error traces with additional context as to where the operation was started.
Optional noWhen set to true, messages published by this client will not match this client's subscriptions, so the client is guaranteed to never receive self-published messages on a subject that it is listening on.
Optional noIf set to true, the client will not randomize its server connection list.
Optional passSets the password for a client connection. Requires that the user option be set. See authenticator.
Optional pedanticWhen set to true, the server may perform additional checks on protocol message requests. This option is only useful for NATS client development and shouldn't be used, as it affects server performance.
Optional pingSets the number of milliseconds between client initiated ping commands. See maxPingOut.
2 minutes.
Optional portSets the port number on the localhost (127.0.0.1) where the nats-server is running. This option is mutually exclusive with servers.
Optional reconnectWhen set to true, the server will attempt to reconnect so long as maxReconnectAttempts doesn't prevent it.
true
Optional reconnectSet a function that dynamically determines the number of milliseconds that the client should wait for the next reconnect attempt.
Optional reconnectSet the upper bound for a random delay in milliseconds added to reconnectTimeWait.
100 millis
Optional reconnectSet the upper bound for a random delay in milliseconds added to reconnectTimeWait. This only affects TLS connections
1000 millis
Optional reconnectSet the number of millisecods between reconnect attempts.
2000 millis
Optional serversSet the hostport(s) where the client should attempt to connect. This option is mutually exclusive with port.
127.0.0.1:4222
Optional timeoutSets the number of milliseconds the client should wait for a server handshake to be established.
20000 millis
Optional tlsWhen set (can be an empty object), the client requires a secure connection. TlsOptions honored depend on the runtime. Consult the specific NATS javascript client GitHub repo/documentation. When set to null, the client should fail should not connect using TLS. In the case where TLS is available on the server a standard connection will be used. If TLS is required, the connection will fail.
Optional tokenSet to a client authentication token. Note that these tokens are a specific authentication strategy on the nats-server. This option is mutually exclusive of user and pass. See authenticator.
Optional userSets the username for a client connection. Requires that the pass option be set. See authenticator.
Optional verboseWhen set to true, the server will send response to all server commands. This option is only useful for NATS client development and shouldn't be used, as it affects server performance.
Optional waitWhen set to true maxReconnectAttempts will not trigger until the client has established one connection.
Generated using TypeDoc
When the server requires authentication, set an Authenticator. An authenticator is created automatically for username/password and token authentication configurations if user and pass or the token options are set.