This is the documentation of version 0.62.3. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Class SDKAbortError

    Error class for cancelled service calls.

    Thrown when the signal passed to a service call is aborted, either before the request is sent or while it is in flight. Its name is 'AbortError', matching the convention used by fetch, and the original abort reason — including a custom value passed to AbortController.abort(reason) — is available on cause.

    To drop a call a newer one supersedes without catching this error, run it through createLatestRequest.

    try {
    await discoverPlaces({ query: 'cafe', signal: AbortSignal.timeout(5000) });
    } catch (error) {
    if (error instanceof SDKAbortError) return showMessage('Search timed out');
    throw error;
    }

    Hierarchy (View Summary)

    Index
    • Creates a new SDKAbortError instance.

      Parameters

      • service: string

        Name of the service whose call was cancelled

      • Optionalcause: unknown

        The abort reason carried by the signal

      Returns SDKAbortError

    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.

    • 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