TomTom Maps for JavaScript
    Preparing search index...

    Class SDKError

    Base error class for all SDK-related errors.

    The SDK handles two distinct categories of errors:

    1. Programming errors: Configuration or usage errors in the user's application, such as passing incorrect types to parameters or functions.
    2. API errors: Recoverable errors that occur during SDK operations, such as network failures or invalid API responses.
    try {
      // SDK operation
    } catch (error) {
      if (error instanceof SDKError) {
        console.error(`Error in ${error.service}: ${error.message}`);
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cause? issues? message name service stack? stackTraceLimit

    Methods

    captureStackTrace isError prepareStackTrace

    Constructors

    • Creates a new SDKError instance.

      Parameters

      • message: string

        Human-readable error description

      • service: string

        Name of the service where the error occurred

      • Optionalissues: $ZodIssue[]

        Optional array of Zod validation issues for detailed error information

      Returns SDKError

    Properties

    cause?: unknown
    issues?: $ZodIssue[]

    Optional array of Zod validation issues for detailed error information

    message: string
    name: string
    service: string

    Name of the service where the error occurred

    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.

    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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods