Class EncodingError

    Error thrown when encoding/decoding operations fail

    Used for proto encoding/decoding, bech32, hex, or other format conversions.

    Example

    try {
      const decoded = bech32Decode(address)
    } catch (error) {
      if (error instanceof EncodingError) {
        console.error('Failed to decode address:', error.message)
      }
    }
    Hierarchy

    Constructors

    constructor

    Properties

    cause? code details? message name stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    constructor

    Properties

    Optionalcause

    cause?: unknown

    Readonlycode

    code: string

    Error code for categorizing the error

    Optional Readonlydetails

    details?: unknown

    Additional error details (can be any type)

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    StaticstackTraceLimit

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject: object, constructorOpt?: Function): void

      Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    StaticprepareStackTrace

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods