Class MwbotError<K>

constructor

• new MwbotError<K extends keyof MwbotErrorCodes = keyof MwbotErrorCodes>(
      type: K,
      config: K extends "api"
          ? ApiResponseError
          : Omit<ApiResponseError, "code"> & { code: keyof MwbotErrorCodes[K] },
      data?: MwbotErrorData,
  ): MwbotError<K>

  Creates a new instance.

  Type Parameters

  • K extends keyof MwbotErrorCodes = keyof MwbotErrorCodes

  Parameters

  • type: K

    The type of the error.
  • config: K extends "api"
        ? ApiResponseError
        : Omit<ApiResponseError, "code"> & { code: keyof MwbotErrorCodes[K] }

    The error details object. This object must contain code and info properties. Other properties are merged into the data property of the new instance.
  • Optionaldata: MwbotErrorData

    Optional object to initialize the data property with.

  Returns MwbotError<K>

  Throws

  If config is not a plain object.

code

Optionaldata

info

type

message

• get message(): string

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

  Returns string

setCode

• setCode(code: K extends "api" ? string : keyof MwbotErrorCodes[K]): this

  Updates the error code.

  Parameters

  • code: K extends "api" ? string : keyof MwbotErrorCodes[K]

    The new error code.

  Returns this

  The current instance for chaining.

setInfo

• setInfo(info: string): this

  Updates the error information.

  Parameters

  • info: string

    The new error information.

  Returns this

  The current instance for chaining.

StaticnewFromResponse

• newFromResponse(
      response:
          | Required<Pick<ApiResponse, "error">>
          | Required<Pick<ApiResponse, "errors">>,
  ): MwbotError<"api">

  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.