Class: ResumeRedactionError

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

Thrown by resume(checkpoint, input, options) when the paused run's redaction cannot be carried into the resumed leg — refused before anything runs, so a leg its policy could not keep covered never starts:

• 'unreadable' — the checkpoint's runRedaction (the policy the paused run was covered by, as plain data) is not one this library wrote;
• 'missing' — the checkpoint says its run kept values out of its records (footprintjs's redactionMarks: the names it masked) but carries no policy. Every leg of a covered run writes its policy into its checkpoint, so this one was altered; a redact passed to the resume cannot stand in for the policy the run was covered by, so it is refused all the same;
• 'unknown-pattern' — the carried policy names a pattern this side does not hold. A pattern is never compiled from a checkpoint (one built to hang the matcher could come back from storage someone else controls): a carried pattern is a reference to one the agent declares, the library's vocabulary holds, or the resume names — pass the run's redact to resume(checkpoint, input, { redact }) when the run was handed one.

Every way, the resumed leg would write what the paused leg kept out into every record of its own. No policy, pattern, name or value appears in the message.

Extends

• Error

Constructors

Constructor

new ResumeRedactionError(reason): ResumeRedactionError

Defined in: src/core/conversation.ts:189

Parameters

reason

ResumeRedactionReason

Returns

ResumeRedactionError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

code

readonly code: "ERR_RESUME_REDACTION"

Defined in: src/core/conversation.ts:186

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

reason

readonly reason: ResumeRedactionReason

Defined in: src/core/conversation.ts:187

stack?

optional stack?: string

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

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: 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

Error.stackTraceLimit

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

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

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace