Class NatsError

Hierarchy

  • Error
    • NatsError

Constructors

constructor

Properties

api_error? cause? chainedError? code message name permissionContext? stack? prepareStackTrace? stackTraceLimit

Methods

isAuthError isAuthTimeout isJetStreamError isPermissionError isProtocolError jsError captureStackTrace errorForCode

Constructors

constructor

  • new NatsError(message, code, chainedError?): NatsError

  • Parameters

    • message: string
    • code: string
    • Optional chainedError: Error

    Returns NatsError

    Api

    private

Properties

Optional api_error

api_error?: ApiError

Optional cause

cause?: unknown

Optional chainedError

chainedError?: Error

code

code: string

message

message: string

name

name: string

Optional permissionContext

permissionContext?: {
    operation: string;
    queue?: string;
    subject: string;
}

Type declaration

  • operation: string
  • Optional queue?: string
  • subject: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

isAuthError

  • isAuthError(): boolean

  • Returns boolean

isAuthTimeout

  • isAuthTimeout(): boolean

  • Returns boolean

isJetStreamError

  • isJetStreamError(): boolean

  • Returns boolean

isPermissionError

  • isPermissionError(): boolean

  • Returns boolean

isProtocolError

  • isProtocolError(): boolean

  • Returns boolean

jsError

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static errorForCode

  • errorForCode(code, chainedError?): NatsError

  • Parameters

    • code: string
    • Optional chainedError: Error

    Returns NatsError

Settings

Member Visibility

Theme

On This Page

constructorapi_errorcausechainedErrorcodemessagenamepermissionContextstackprepareStackTracestackTraceLimitisAuthErrorisAuthTimeoutisJetStreamErrorisPermissionErrorisProtocolErrorjsErrorcaptureStackTraceerrorForCode