Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/memory / errors / WorkingBlockOverflowError

Class: WorkingBlockOverflowError

Defined in: packages/memory/src/errors/index.ts:82

Raised by WorkingMemory when a write would exceed the declared charLimit and the overflow policy is 'reject'.

Stable

Extends

• GraphorinMemoryError

Constructors

Constructor

new WorkingBlockOverflowError(
   label, 
   attempted, 
   charLimit): WorkingBlockOverflowError;

Defined in: packages/memory/src/errors/index.ts:89

Parameters

Parameter	Type
label	string
attempted	number
charLimit	number

Returns

WorkingBlockOverflowError

Overrides

GraphorinMemoryError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
attempted	readonly	number	undefined	-	-	-	packages/memory/src/errors/index.ts:86
cause?	public	unknown	undefined	-	-	GraphorinMemoryError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
charLimit	readonly	number	undefined	-	-	-	packages/memory/src/errors/index.ts:87
hint?	readonly	string	undefined	Optional actionable hint surfaced to operators.	-	GraphorinMemoryError.hint	packages/memory/src/errors/index.ts:20
kind	readonly	"working-block-overflow"	undefined	Stable lowercase discriminator.	GraphorinMemoryError.kind	-	packages/memory/src/errors/index.ts:84
label	readonly	string	undefined	-	-	-	packages/memory/src/errors/index.ts:85
message	public	string	undefined	-	-	GraphorinMemoryError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	readonly	"WorkingBlockOverflowError"	'WorkingBlockOverflowError'	-	GraphorinMemoryError.name	-	packages/memory/src/errors/index.ts:83
stack?	public	string	undefined	-	-	GraphorinMemoryError.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.	-	GraphorinMemoryError.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

GraphorinMemoryError.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

GraphorinMemoryError.prepareStackTrace