[C] UnserializableValueError

Error thrown when a value cannot be serialized.

Extends

• Error

Extended by

• UnsupportedScalarConstructorError

Constructors

Constructor

new UnserializableValueError(reason?): UnserializableValueError;

Creates a serialization failure with the supplied reason as its error message.

Parameters

Parameter	Type	Default value	Description
reason	string	"Cannot serialize value as JSON."	Explanation of the failure; defaults to “Cannot serialize value as JSON.”

Returns

UnserializableValueError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from
cause?	public	unknown	undefined	-	Error.cause
message	public	string	undefined	-	Error.message
name	public	string	undefined	-	Error.name
reason	readonly	string	"Cannot serialize value as JSON."	Explanation of the failure; defaults to “Cannot serialize value as JSON.”	-
stack?	public	string	undefined	-	Error.stack
stackTraceLimit	static	number	undefined	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.	Error.stackTraceLimit

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.

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace