zeropdf v1.3.0

---

zeropdf / PdfEngineError

Class: PdfEngineError

Defined in: src/errors.ts:91

A structured error type thrown when PDF generation, parsing, validation, or editing fails. It carries a stable error code and optional diagnostic details.

Extends

• Error

Constructors

Constructor

new PdfEngineError(
   code, 
   message, 
   details?): PdfEngineError;

Defined in: src/errors.ts:104

Creates a structured PDF engine error with a stable code and optional details.

Parameters

Parameter	Type	Description
code	PdfErrorCode	The stable error code for the failure.
message	string	The human-readable error message.
details?	Record<string, unknown>	Optional diagnostic details for the error.

Returns

PdfEngineError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	node_modules/typescript/lib/lib.es2022.error.d.ts:24
code	readonly	PdfErrorCode	Stable machine-readable issue or error code.	-	src/errors.ts:93
details?	readonly	Record<string, unknown>	Optional diagnostic details supplied with the error.	-	src/errors.ts:95
message	public	string	-	Error.message	node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	Error.name	node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	Error.stack	node_modules/typescript/lib/lib.es5.d.ts:1076
stackTraceLimit	static	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.	Error.stackTraceLimit	node_modules/@types/node/globals.d.ts:67

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace