Graphorin API reference v0.8.0

---

Graphorin API reference / @graphorin/core / / AwakeablePayloadError

Class: AwakeablePayloadError

Defined in: packages/core/src/channels/durable.ts:148

Thrown by awaitExternal when the resolved payload fails the declared schema. The workflow engine recognises it by name and RESTORES the suspension instead of failing the thread: the invalid value is discarded, the pending pause survives, and the resolver receives a typed awakeable-payload-invalid error. Validation runs at the replay delivery point (the node re-executing with the resumed value) because that is the only place the schema object exists - PendingPauseRecord persists name/wakeAt only and a schema is not serializable across processes.

Stable

Extends

• TypeError

Constructors

Constructor

new AwakeablePayloadError(awakeableName, issues): AwakeablePayloadError;

Defined in: packages/core/src/channels/durable.ts:150

Parameters

Parameter	Type
awakeableName	string
issues	string

Returns

AwakeablePayloadError

Overrides

TypeError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
awakeableName	readonly	string	undefined	-	-	-	packages/core/src/channels/durable.ts:151
cause?	public	unknown	undefined	-	-	TypeError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
issues	readonly	string	undefined	-	-	-	packages/core/src/channels/durable.ts:152
message	public	string	undefined	-	-	TypeError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	readonly	"AwakeablePayloadError"	'AwakeablePayloadError'	-	TypeError.name	-	packages/core/src/channels/durable.ts:149
stack?	public	string	undefined	-	-	TypeError.stack	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	undefined	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.	-	TypeError.stackTraceLimit	node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

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

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

TypeError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TypeError.prepareStackTrace