WXT

Appearance

API > wxt/utils/storage > MigrationError

Class: MigrationError ​

Contents ​

Extends ​

  • Error

Constructors ​

new MigrationError(key, version, options) ​

new MigrationError(key, version, options?): MigrationError

Parameters ​

▪ key: string

▪ version: number

▪ options?: ErrorOptions

Overrides ​

Error.constructor

Source ​

packages/storage/dist/index.d.mts:286

Properties ​

cause ​

cause?: unknown

Inherited from ​

Error.cause

Source ​

node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26

key ​

key: string

Source ​

packages/storage/dist/index.d.mts:284

message ​

message: string

Inherited from ​

Error.message

Source ​

node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1077

name ​

name: string

Inherited from ​

Error.name

Source ​

node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1076

stack ​

stack?: string

Inherited from ​

Error.stack

Source ​

node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1078

version ​

version: number

Source ​

packages/storage/dist/index.d.mts:285

stackTraceLimit ​

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

Inherited from ​

Error.stackTraceLimit

Source ​

node_modules/.pnpm/@types+node@20.19.13/node_modules/@types/node/globals.d.ts:68

Methods ​

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): 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.

js
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:

js
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

▪ constructorOpt?: Function

Inherited from ​

Error.captureStackTrace

Source ​

node_modules/.pnpm/@types+node@20.19.13/node_modules/@types/node/globals.d.ts:52

isError() ​

static isError(error): error is Error

Indicates whether the argument provided is a built-in Error instance or not.

Parameters ​

▪ error: unknown

Inherited from ​

Error.isError

Source ​

node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.esnext.error.d.ts:23

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Parameters ​

▪ err: Error

▪ stackTraces: CallSite[]

Returns ​

Inherited from ​

Error.prepareStackTrace

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Source ​

node_modules/.pnpm/@types+node@20.19.13/node_modules/@types/node/globals.d.ts:56

Generated using typedoc-plugin-markdown and TypeDoc