PdfEncryptionError
Class PdfEncryptionError
class PdfEncryptionError extends ErrorConstructors
constructor
PdfEncryptionError(code: PdfEncryptionErrorCode, message: string, options?: ErrorOptions): PdfEncryptionErrorParameters
-
code: PdfEncryptionErrorCode -
message: string -
options?: ErrorOptions
Returns PdfEncryptionError
Properties
cause
unknownThe cause of the error.
code
PdfEncryptionErrorCodemessage
stringname
stringstack
stringstackTraceLimit
numberThe 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.
Methods
captureStackTrace
captureStackTrace(targetObject: object, constructorOpt?: Function): voidCreates 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
captureStackTrace(targetObject: object, constructorOpt?: Function): voidCreate .stack property on a target object
Parameters
-
targetObject: object -
constructorOpt?: Function
Returns void
isError
isError(error: unknown): error is ErrorIndicates whether the argument provided is a built-in Error instance or not.
Parameters
-
error: unknown
Returns error is Error
isError(value: unknown): value is ErrorCheck if a value is an instance of Error
Parameters
value: unknownThe value to check
Returns value is Error
True if the value is an instance of Error, false otherwise
prepareStackTrace
prepareStackTrace(err: Error, stackTraces: CallSite[]): anyParameters
-
err: Error -
stackTraces: CallSite[]
Returns any