Skip to main content

StorageQuotaError

Defined in: node_modules/achievements-engine/dist/index.d.ts:435

Error thrown when browser storage quota is exceeded

Extends

Constructors

Constructor

new StorageQuotaError(bytesNeeded): StorageQuotaError

Defined in: node_modules/achievements-engine/dist/index.d.ts:437

Parameters

bytesNeeded

number

Returns

StorageQuotaError

Overrides

AchievementError.constructor

Properties

bytesNeeded

bytesNeeded: number

Defined in: node_modules/achievements-engine/dist/index.d.ts:436


cause?

optional cause: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

AchievementError.cause


code

code: string

Defined in: node_modules/achievements-engine/dist/index.d.ts:427

Inherited from

AchievementError.code


message

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

AchievementError.message


name

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

AchievementError.name


recoverable

recoverable: boolean

Defined in: node_modules/achievements-engine/dist/index.d.ts:428

Inherited from

AchievementError.recoverable


remedy?

optional remedy: string

Defined in: node_modules/achievements-engine/dist/index.d.ts:429

Inherited from

AchievementError.remedy


stack?

optional stack: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

AchievementError.stack


stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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

AchievementError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

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

constructorOpt?

Function

Returns

void

Inherited from

AchievementError.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

AchievementError.prepareStackTrace