nexus-rpc
    Preparing search index...

    Class OperationErrorExperimental

    A Nexus operation error.

    This error class represents the abnormal completion of a Nexus operation, that should be reported to the caller as an operation error.

    Example:

        import { OperationError } from "nexus-rpc";

        // Throw a failed operation error
        throw new OperationError("failed", "Not enough inventory");

        // Throw a failed operation error, with a cause
        throw new OperationError("failed", "Not enough inventory", { cause });

        // Throw a canceled operation error
        throw new OperationError("canceled", "User canceled the operation");

    Hierarchy

    • Error
      • OperationError
    Index

    Constructors

    constructor

    Properties

    cause message name stack? state stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Experimental

      Constructs a new OperationError.

      Parameters

      • state: "failed" | "canceled"

        The state of the operation.

      • Optionalmessage: string

        The message of the error.

      • Optionaloptions: { cause?: Error }

        Extra options for the error, e.g. the cause.

        • Optionalcause?: Error

          Underlying cause of the error.

      Returns OperationError

    Properties

    cause: Error

    The error that resulted in this operation error.

    message: string
    name: string
    stack?: string
    state: "failed" | "canceled"

    State of the operation.

    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

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods