Class CommitError

CommitError is thrown to indicate that a transaction committed with an unsuccessful status code.

Hierarchy

  • Error
    • CommitError

Constructors

constructor

Properties

cause? code message name stack? transactionId prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new CommitError(properties): CommitError

  • Parameters

    • properties: Readonly<{
          code: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 254 | 255;
          message?: string;
          transactionId: string;
      }>

    Returns CommitError

Properties

Optional cause

cause?: unknown

code

code: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 254 | 255

Transaction validation status code. The value corresponds to one of the values enumerated by StatusCode.

message

message: string

name

name: string

Optional stack

stack?: string

transactionId

transactionId: string

The ID of the transaction.

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

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestacktransactionIdprepareStackTracestackTraceLimitcaptureStackTrace