Selva Compute API Reference - v1.1.2
    Preparing search index...

    Class RhinoComputeError

    Simplified error for Rhino Compute operations

    Use this for error handling with error codes and context.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    code context? message name originalError? stack? statusCode? stackTraceLimit

    Methods

    captureStackTrace invalidDefault invalidStructure missingValues prepareStackTrace unknownParamType validation

    Constructors

    • Parameters

      • message: string
      • code: string = 'UNKNOWN_ERROR'
      • Optionaloptions: {
            context?: Record<string, unknown>;
            originalError?: Error;
            statusCode?: number;
        }

      Returns RhinoComputeError

    Properties

    code: string
    context?: Record<string, unknown>
    message: string
    name: string
    originalError?: Error
    stack?: string
    statusCode?: number
    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

    • 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

    • Create an error for invalid default value in value list

      Parameters

      • inputName: string
      • defaultValue: unknown
      • availableValues: unknown[]
      • Optionalcontext: Record<string, unknown>

      Returns RhinoComputeError

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods