Skip to content

Graphorin API reference v0.5.0


Graphorin API reference / @graphorin/workflow / errors / CheckpointVersionConflictError

Class: CheckpointVersionConflictError

Defined in: packages/workflow/src/errors/index.ts:200

Thrown when a checkpoint write detects that another writer advanced the thread concurrently (WF-12) — the loser must not fork the timeline.

Extends

Constructors

Constructor

ts
new CheckpointVersionConflictError(
   threadId, 
   expectedParentId, 
   actualLatestId): CheckpointVersionConflictError;

Defined in: packages/workflow/src/errors/index.ts:205

Parameters

ParameterType
threadIdstring
expectedParentIdstring
actualLatestIdstring

Returns

CheckpointVersionConflictError

Overrides

WorkflowError.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
actualLatestIdreadonlystring--packages/workflow/src/errors/index.ts:203
cause?readonlyunknown-WorkflowError.causepackages/workflow/src/errors/index.ts:42
codereadonlyWorkflowErrorCode-WorkflowError.codepackages/workflow/src/errors/index.ts:41
expectedParentIdreadonlystring--packages/workflow/src/errors/index.ts:202
hint?readonlystring-WorkflowError.hintpackages/workflow/src/errors/index.ts:43
messagepublicstring-WorkflowError.messagenode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-WorkflowError.namenode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-WorkflowError.stacknode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078
threadIdreadonlystring--packages/workflow/src/errors/index.ts:201
stackTraceLimitstaticnumberThe 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.WorkflowError.stackTraceLimitnode_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
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:

js
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

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

WorkflowError.captureStackTrace


prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

WorkflowError.prepareStackTrace