Authenticator is an interface that returns credentials.
Returns a Backoff with the specified interval policy set.
Class representing an error thrown when an operation is attempted on a closed connection.
Represents an error that occurs when a network connection fails. Extends the built-in Error class to provide additional context for connection-related issues.
Returns an Authenticator function that returns a JwtAuth. This is a convenience Authenticator that parses the specified creds and delegates to the jwtAuthenticator.
Returns a Promise that has a resolve/reject methods that can be used to resolve and defer the Deferred.
The ConnectionDrainingError class represents a specific type of error
that occurs when a connection is being drained.
InvalidOperationError is a custom error class that extends the standard Error object. It represents an error that occurs when an invalid operation is attempted on one of objects returned by the API. For example, trying to iterate on an object that was configured with a callback.
Represents an error that is thrown when an invalid subject is encountered. This class extends the built-in Error object.
Returns an Authenticator function that returns a JwtAuth. If a seed is provided, the public key, and signature are calculated.
Convert the specified Nanos into millis
Value expressed as Nanoseconds - use the nanos(millis) function
to convert millis to nanoseconds. Note that in some environments this
could overflow.
Converts the specified millis into Nanos
Returns an Authenticator that returns a NKeyAuth based that uses the specified seed or function returning a seed.
NoRespondersError is an error thrown when no responders (no service is subscribing to the subject) are found for a given subject. This error is typically found as the cause for a RequestError
Class representing a Permission Violation Error. It provides information about the operation (either "publish" or "subscription") and the subject used for the operation and the optional queue (if a subscription).
Represents an error encountered during protocol operations.
This class extends the built-in Error class, providing a specific
error type called ProtocolError.
Class representing an error that occurs during an request operation (such as TimeoutError, or NoRespondersError, or some other error).
A reviver function
ServerInfo represents information from the connected server
ServerChanged records servers in the cluster that were added or deleted.
Basic interface to a Subscription type
Subscription Options
syncIterator is a utility function that allows an AsyncIterator to be triggered by calling next() - the utility will yield null if the underlying iterator is closed. Note it is possibly an error to call use this function on an AsyncIterable that has already been started (Symbol.asyncIterator() has been called) from a looping construct.
TimeoutError is a custom error class that extends the built-in Error class. It is used to represent an error that occurs when an operation exceeds a predefined time limit.
TlsOptions that can be specified to a client. Note that the options are typically runtime specific, so some clients won't support them at all. In other cases they will match to the runtime's TLS options.
Returns a token authenticator for the specified token
Represents an error indicating that user authentication has expired. This error is typically thrown when a user attempts to access a connection but their authentication credentials have expired.
Returns a user/pass authenticator for the specified user and optional password
Authenticator is an interface that returns credentials.
Returns a Backoff with the specified interval policy set.
Class representing an error thrown when an operation is attempted on a closed connection.
Represents an error that occurs when a network connection fails. Extends the built-in Error class to provide additional context for connection-related issues.
Returns an Authenticator function that returns a JwtAuth. This is a convenience Authenticator that parses the specified creds and delegates to the jwtAuthenticator.
Returns a Promise that has a resolve/reject methods that can be used to resolve and defer the Deferred.
The ConnectionDrainingError class represents a specific type of error
that occurs when a connection is being drained.
Called with the number of missed heartbeats. If the function returns true, the monitor will cancel monitoring.
InvalidOperationError is a custom error class that extends the standard Error object. It represents an error that occurs when an invalid operation is attempted on one of objects returned by the API. For example, trying to iterate on an object that was configured with a callback.
Represents an error that is thrown when an invalid subject is encountered. This class extends the built-in Error object.
Returns an Authenticator function that returns a JwtAuth. If a seed is provided, the public key, and signature are calculated.
Convert the specified Nanos into millis
Value expressed as Nanoseconds - use the nanos(millis) function
to convert millis to nanoseconds. Note that in some environments this
could overflow.
Converts the specified millis into Nanos
Returns an Authenticator that returns a NKeyAuth based that uses the specified seed or function returning a seed.
NoRespondersError is an error thrown when no responders (no service is subscribing to the subject) are found for a given subject. This error is typically found as the cause for a RequestError
Class representing a Permission Violation Error. It provides information about the operation (either "publish" or "subscription") and the subject used for the operation and the optional queue (if a subscription).
Represents an error encountered during protocol operations.
This class extends the built-in Error class, providing a specific
error type called ProtocolError.
- _closed
- _doDial
- _sub
- _subunsub
- abortReconnect
- close
- closed
- connect
- connectError
- connectPromise
- connected
- connectedOnce
- dial
- dialDelay
- dialLoop
- disconnect
- disconnected
- dispatchStatus
- dodialLoop
- drain
- features
- flush
- flushPending
- getServer
- handleAuthError
- handleError
- heartbeats
- inBytes
- inMsgs
- info
- infoReceived
- initMux
- isClosed
- lastError
- listeners
- muxSubscriptions
- noMorePublishing
- options
- outBytes
- outMsgs
- outbound
- parser
- pendingLimit
- pongs
- prepare
- processError
- processInfo
- processMsg
- processPing
- processPong
- publish
- publisher
- push
- raceTimer
- reconnect
- request
- resetOutbound
- resub
- selectServer
- sendCommand
- sendSubscriptions
- server
- servers
- subscribe
- subscriptions
- toError
- transport
- unsub
- unsubscribe
- whyClosed
Class representing an error that occurs during an request operation (such as TimeoutError, or NoRespondersError, or some other error).
Result is a value that may have resulted in an error.
A reviver function
ServerInfo represents information from the connected server
ServerChanged records servers in the cluster that were added or deleted.
Basic interface to a Subscription type
Subscription Options
syncIterator is a utility function that allows an AsyncIterator to be triggered by calling next() - the utility will yield null if the underlying iterator is closed. Note it is possibly an error to call use this function on an AsyncIterable that has already been started (Symbol.asyncIterator() has been called) from a looping construct.
TimeoutError is a custom error class that extends the built-in Error class. It is used to represent an error that occurs when an operation exceeds a predefined time limit.
TlsOptions that can be specified to a client. Note that the options are typically runtime specific, so some clients won't support them at all. In other cases they will match to the runtime's TLS options.
Returns a token authenticator for the specified token
Represents an error indicating that user authentication has expired. This error is typically thrown when a user attempts to access a connection but their authentication credentials have expired.
Returns a user/pass authenticator for the specified user and optional password