Error Types

• CasualOSError

  Defines a class that represents a generic CasualOS error.

  Members

  • cause? unknown

  • errorCode string

    The error code that occurred.

  • errorMessage string

    The error message that occurred.

  • 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.

  • constructor(error: (string | GenericError)): CasualOSError

    The first parameter is a (string | GenericError) and

  • static captureStackTrace(targetObject: object, constructorOpt?: Function): void

    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();
    

    The first parameter is a object and

    The second parameter is optional and is a Function and

  • static prepareStackTrace(err: Error, stackTraces: CallSite[]): any

    The first parameter is a Error and

    The second parameter is a CallSite[] and