Base exception class for all service exceptions from Apiv2 service.

Hierarchy (View Summary)

Constructors

  • Internal

    Parameters

    • options: ServiceExceptionOptions

    Returns Apiv2ServiceException

Properties

$fault: "client" | "server"

Whether the client or server are at fault.

$metadata: ResponseMetadata

Metadata pertaining to this request.

$response?: HttpResponse

Reference to low-level HTTP response object.

$retryable?: RetryableTrait

Indicates that an error MAY be retried by the client.

cause?: unknown
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.

Methods

  • Custom instanceof check to support the operator for ServiceException base class

    Parameters

    • instance: unknown

    Returns boolean

  • 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

  • Checks if a value is an instance of ServiceException (duck typed)

    Parameters

    • value: unknown

    Returns value is ServiceException