nexus-rpc
    Preparing search index...

    Class HandlerErrorExperimental

    A Nexus handler error.

    This error class represents an error that occurred during the handling of a Nexus operation that should be reported to the caller as a handler error.

    Example:

        import { HandlerError } from "nexus-rpc";

        // Throw a bad request error
        throw new HandlerError("BAD_REQUEST", "Invalid input provided");

        // Throw a bad request error, with a cause
        throw new HandlerError("BAD_REQUEST", "Invalid input provided", { cause });

        // Throw a retryable internal error
        throw new HandlerError("INTERNAL", "Database unavailable", { retryableOverride: true });

    Hierarchy

    • Error
      • HandlerError
    Index

    Constructors

    constructor

    Properties

    cause? message name originalFailure? rawErrorType retryableOverride? stack? type stackTraceLimit

    Accessors

    retryable

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Experimental

      Constructs a new HandlerError.

      Parameters

      • type: HandlerErrorType

        The type of the error. Must be a known HandlerErrorType.

      • Optionalmessage: string

        The message of the error.

      • Optionaloptions: {
            cause?: unknown;
            originalFailure?: Failure;
            rawErrorType?: string;
            retryableOverride?: boolean;
            stackTrace?: string;
        }

        Extra options for the error, including the cause and retryable override.

        • Optionalcause?: unknown

          Underlying cause of the error.

        • OptionaloriginalFailure?: Failure

          An optional Failure object from which this error was constructed.

          Preserves the original failure for round-tripping through the wire format.

        • OptionalrawErrorType?: string

          The original error type string, preserving the raw wire value.

          For known types, this option is ignored. When the error's type is set to "UNKNOWN", this option is used to preserve the original wire string.

        • OptionalretryableOverride?: boolean

          Whether this error should be considered retryable.

          If not set, the retry behavior is determined from the error type. For example, by default, INTERNAL is retryable, but UNAVAILABLE is non-retryable.

        • OptionalstackTrace?: string

          An optional stack trace string associated with this error.

          When provided, this overrides the native stack property on the error. This is typically used for remote stack traces received over the wire, which may originate from a different language runtime.

      Returns HandlerError

    Properties

    cause?: unknown
    message: string
    name: string
    originalFailure?: Failure

    Set if this error was constructed from a Failure object.

    Preserves the original failure for round-tripping through the wire format.

    rawErrorType: string

    The raw error type string.

    For known types, this equals type. For unknown types, this preserves the original wire string while type is set to "UNKNOWN".

    retryableOverride?: boolean

    Whether this error should be considered retryable.

    By default, the retry behavior is determined from the error type. For example, by default, INTERNAL is retryable, but UNAVAILABLE is non-retryable.

    If specified, retryableOverride overrides the default retry behavior determined based on the error type. Use retryable to determine the effective retry behavior.

    retryable.

    stack?: string
    type: HandlerErrorType

    One of the predefined error types.

    If the constructor received an unknown string, this will be "UNKNOWN". Use rawErrorType to access the original string.

    HandlerErrorType

    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.

    Accessors

    Methods

    • Experimental

      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

    • Experimental

      Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods