Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/provider / / CostBudgetExceededError

Class: CostBudgetExceededError

Defined in: packages/provider/src/errors/errors.ts:98

withCostLimit exceeded its configured ceiling. Carries the triggering scope (session, agent, run, …) so the caller can decide how to surface the breach.

Stable

Extends

• GraphorinProviderError

Constructors

Constructor

new CostBudgetExceededError(args): CostBudgetExceededError;

Defined in: packages/provider/src/errors/errors.ts:104

Parameters

Parameter	Type
args	{ currency?: string; limit: number; observed: number; scope: string; }
args.currency?	string
args.limit	number
args.observed	number
args.scope	string

Returns

CostBudgetExceededError

Overrides

GraphorinProviderError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
cause?	public	unknown	undefined	-	-	GraphorinProviderError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?	readonly	string	undefined	Optional remediation hint shown alongside the message.	-	GraphorinProviderError.hint	packages/provider/src/errors/errors.ts:21
kind	readonly	string	undefined	Stable discriminant — 'middleware-ordering', 'rate-limit-exceeded', …	-	GraphorinProviderError.kind	packages/provider/src/errors/errors.ts:19
limit	readonly	number	undefined	-	-	-	packages/provider/src/errors/errors.ts:101
message	public	string	undefined	-	-	GraphorinProviderError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	readonly	"CostBudgetExceededError"	'CostBudgetExceededError'	-	GraphorinProviderError.name	-	packages/provider/src/errors/errors.ts:99
observed	readonly	number	undefined	-	-	-	packages/provider/src/errors/errors.ts:102
scope	readonly	string	undefined	-	-	-	packages/provider/src/errors/errors.ts:100
stack?	public	string	undefined	-	-	GraphorinProviderError.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.	-	GraphorinProviderError.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

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

GraphorinProviderError.prepareStackTrace