mwbot-ts - v1.3.2
    Preparing search index...

    Class MwbotError<K>

    Custom error class for Mwbot, extending the built-in Error class. This class is exported for use with the instanceof operator.

    This error class is used throughout Mwbot to standardize error handling, ensuring that all errors and rejected Promises include a stack trace for easier debugging.

    For a list of error codes, see MwbotErrorCodes.

    Type Parameters

    Hierarchy

    • Error
      • MwbotError
    Index

    Constructors

    constructor

    Properties

    cause? code data? info name stack? type stackTraceLimit

    Accessors

    message

    Methods

    setCode setInfo captureStackTrace newFromResponse prepareStackTrace

    Constructors

    Properties

    cause?: unknown
    code: string

    The code of the error.

    data?: MwbotErrorData

    Additional data of the error.

    info: string

    The information of the error.

    name: string
    stack?: string
    type: K

    The type of the error.

    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

    • get message(): string

      Returns the info property. This property is only for compatibility with the parent Error class.

      Returns string

    Methods

    • Updates the error information.

      Parameters

      • info: string

        The new error information.

      Returns this

      The current instance for chaining.

    • 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

    • Creates a new instance from an API error response.

      Parameters

      • response: Required<Pick<ApiResponse, "error">> | Required<Pick<ApiResponse, "errors">>

        An API response with the error or errors property.

      Returns MwbotError<"api">

      A new MwbotError instance.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods