RevocationError
PQSafe AgentPay API Reference v0.1.0
PQSafe AgentPay API Reference / RevocationError
Class: RevocationError
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:296
Thrown when an envelope has been revoked via any layer. Never retriable.
Extends
Constructors
Constructor
new RevocationError(
params):RevocationError
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:297
Parameters
params
Omit<PQSafeErrorParams, "code"> & object
Returns
RevocationError
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: pqsafe-docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:PQSafeErrorCode
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:231
Fine-grained stable error code. Safe for programmatic matching.
Inherited from
context
readonlycontext:Record<string,unknown>
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:239
Structured context for inspection.
Inherited from
error_class
readonlyerror_class:ErrorClass
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:229
Broad category of error. Use for routing and alerting.
Inherited from
human_reason
readonlyhuman_reason:string
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:237
Operator-readable explanation.
Inherited from
is_retriable
readonlyis_retriable:boolean
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:233
Whether the same call may succeed if retried (after delay or new envelope).
Inherited from
message
message:
string
Defined in: pqsafe-docs/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: pqsafe-docs/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
retry_after_ms
readonlyretry_after_ms:number|undefined
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:235
Minimum wait before retry (ms). Undefined if not retriable.
Inherited from
stack?
optionalstack?:string
Defined in: pqsafe-docs/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: pqsafe/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.
Inherited from
Methods
toJSON()
toJSON():
Record<string,unknown>
Defined in: pqsafe/agent-pay/src/sprint2/errors.ts:255
Serialize to a JSON-safe object (for API responses and structured logging).
Returns
Record<string, unknown>
Inherited from
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: pqsafe/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
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: pqsafe/node_modules/@types/node/globals.d.ts:55
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces