core-utils
    Preparing search index...

    Class ServiceError

    Error class for service-level errors, convertible to JSON:API errors.

    Hierarchy

    • Error
      • ServiceError
    Index

    Constructors

    constructor

    Properties

    cause? id issues message name source stack? status stackTraceLimit

    Methods

    toJsonApi toString captureStackTrace fromJsonApi fromUnknown fromZodError merge prepareStackTrace

    Constructors

    Properties

    cause?: unknown
    id: string
    issues: readonly Issue[]
    message: string
    name: string
    source: ErrorSource
    stack?: string
    status: 400 | 401 | 403 | 404 | 409 | 422 | 429 | 500
    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

    • Converts the error to JSON:API format

      Returns {
          errors: {
              code: ErrorCode;
              detail?: string;
              id: string;
              source?: { [key: string]: string };
              status: string;
              title: string | undefined;
          }[];
      }

      Object conforming to JSON:API error format

      https://jsonapi.org/format/#error-objects

    • 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

    • Creates a ServiceError from a JSON:API error object

      Parameters

      • jsonApiError: {
            errors: {
                code?: ErrorCode;
                detail?: string;
                id?: string;
                source?: Record<string, string>;
                status?: "400" | "401" | "403" | "404" | "409" | "422" | "429" | "500";
                title?: string;
            }[];
        }

        JSON:API error object

      Returns ServiceError

      New ServiceError instance

      https://jsonapi.org/format/#error-objects

    • Converts an unknown value to a ServiceError. Typically called from catch blocks.

      Parameters

      • value: unknown

        The value to convert, which can be any type

      Returns ServiceError

      If the value is already a ServiceError, returns it unchanged. Otherwise, convert it to a ServiceError.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods