Skip to main content

Class: ExternalStorageDriverError

Experimental

Thrown when a storage driver's store or retrieve operation fails.

Extends​

Constructors​

Constructor​

new ExternalStorageDriverError(message, opts?): ExternalStorageDriverError

Experimental

Parameters​

message​

string

opts?​
cause?​

unknown

Returns​

ExternalStorageDriverError

Overrides​

ExternalStorageError.constructor

Properties​

cause?​

readonly optional cause?: unknown

Experimental

Overrides​

ExternalStorageError.cause

message​

message: string

Experimental

Inherited from​

ExternalStorageError.message

name​

name: string

Experimental

Inherited from​

ExternalStorageError.name

stack?​

optional stack?: string

Experimental

Inherited from​

ExternalStorageError.stack

stackTraceLimit​

static stackTraceLimit: number

Experimental

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​

ExternalStorageError.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Experimental

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​

ExternalStorageError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Experimental

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

ExternalStorageError.prepareStackTrace