Class: E_ENCODING_FAILED

Exception thrown when encoding fails due to an underlying error. This wraps the original error as the cause for better error tracing.

Extends

• BaseException

Constructors

Constructor

new E_ENCODING_FAILED(value: unknown, cause: unknown): E_ENCODING_FAILED;

Creates a new E_ENCODING_FAILED exception.

Parameters

Parameter	Type	Description
value	unknown	The value that failed to encode.
cause	unknown	The underlying error that caused the encoding to fail.

Returns

E_ENCODING_FAILED

Overrides

BaseException.constructor;

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
cause?	public	unknown	undefined	-	-	BaseException.cause
code?	public	string	undefined	A machine readable error code. This will allow the error handling logic to narrow down exceptions based upon the error code.	-	BaseException.code
help?	public	string	undefined	Optional help description for the error. You can use it to define additional human readable information for the error.	-	BaseException.help
message	public	string	undefined	-	-	BaseException.message
name	public	string	undefined	Name of the class that raised the exception.	-	BaseException.name
stack?	public	string	undefined	-	-	BaseException.stack
status	public	number	undefined	A status code for the error. Usually helpful when converting errors to HTTP responses.	-	BaseException.status
code	static	string	'E_ENCODING_FAILED'	-	BaseException.code	-
help?	static	string	undefined	Define the error metadata as static properties to avoid setting them repeatedly on the error instance	-	BaseException.help
message?	static	string	undefined	-	-	BaseException.message
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.	-	BaseException.stackTraceLimit
status	static	number	500	-	BaseException.status	-

Accessors

[toStringTag]

Get Signature

get toStringTag: string;

Returns the constructor name for the Symbol.toStringTag property.

Returns

string

The name of the exception class.

Inherited from

BaseException.[toStringTag]

Methods

toString()

toString(): string;

Returns a string representation of the exception. Includes the error code in brackets if available.

Returns

string

A formatted string representation of the exception.

Inherited from

BaseException.toString

---

captureStackTrace()

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

BaseException.captureStackTrace;

---

isError()

static isError(error: unknown): error is Error;

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

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

BaseException.isError;

---

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

BaseException.prepareStackTrace;