@aptos-labs/ts-sdk - v5.1.4
    Preparing search index...

    Class ParsingError<T>

    This error is used to explain why parsing failed.

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Implementation - Serialization

    • Creates an instance of the error with a specified message and invalid reason.

      Type Parameters

      • T

      Parameters

      • message: string

        The error message that describes the issue.

      • invalidReason: T

        The reason why the input is considered invalid.

      Returns ParsingError<T>

    invalidReason: T

    This provides a programmatic way to access why parsing failed. Downstream devs might want to use this to build their own error messages if the default error messages are not suitable for their use case. This should be an enum.

    Methods

    • 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

    Properties

    message: string
    name: string
    stack?: string
    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.