Skip to content

PermissionsError

@scaryterry/pdfium


Defined in: src/core/errors.ts:261

Error due to insufficient permissions.

Thrown when an operation is blocked by the document’s security settings.

new PermissionsError(message?, context?): PermissionsError

Defined in: src/core/errors.ts:262

ParameterType
message?string
context?Record<string, unknown>

PermissionsError

DocumentError.constructor

optional cause: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

DocumentError.cause


readonly code: PDFiumErrorCode

Defined in: src/core/errors.ts:182

The error code identifying the type of error

DocumentError.code


readonly optional context: Record<string, unknown>

Defined in: src/core/errors.ts:185

Optional context data providing additional information

DocumentError.context


message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

DocumentError.message


name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

DocumentError.name


optional stack: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

DocumentError.stack


static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.2.0/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.

DocumentError.stackTraceLimit

toJSON(): Record<string, unknown>

Defined in: src/core/errors.ts:205

Creates a JSON-serialisable representation of the error.

Record<string, unknown>

DocumentError.toJSON


static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.2.0/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();
ParameterType
targetObjectobject
constructorOpt?Function

void

DocumentError.captureStackTrace


static prepareStackTrace(err, stackTraces): any

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

ParameterType
errError
stackTracesCallSite[]

any

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

DocumentError.prepareStackTrace