RTCForge API Reference v1.1.1
    Preparing search index...

    Class RtcForgeError

    Base class for all errors thrown by RTCForge.

    Every RTCForge error carries a stable machine-readable code in addition to the human-readable message, so callers can branch on the failure kind without matching on message text. The error name is set to the concrete subclass name.

    Use isRtcForgeError to narrow an unknown caught value to this type and, optionally, to a specific code.

    try {
      ring.add({ id: 'node-a', weight: -1 })
    } catch (err) {
      if (isRtcForgeError(err)) {
        console.error(err.code, err.message)
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    code message name stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Parameters

      • message: string

        Human-readable description of what went wrong.

      • code: string

        Stable machine-readable code identifying the failure kind.

      • Optionaloptions: { cause?: unknown }

        Optional settings.

        • Optionalcause?: unknown

          The underlying error or value that caused this error, attached as the standard cause property.

      Returns RtcForgeError

    Properties

    code: string

    Stable machine-readable error code identifying the failure kind (e.g. INVALID_ARGUMENT).

    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

    • 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