Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/provider / / MiddlewareOrderingError

Class: MiddlewareOrderingError

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

The middleware composer detected an out-of-order middleware. The offendingPair field carries the [outer, inner] middleware names that violated the canonical order so consumers can surface a precise fix in IDE diagnostics.

Stable

Extends

Constructors

Constructor

ts
new MiddlewareOrderingError(args): MiddlewareOrderingError;

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

Parameters

ParameterType
args{ canonicalOrder: readonly string[]; message?: string; offendingPair: readonly [string, string]; }
args.canonicalOrderreadonly string[]
args.message?string
args.offendingPairreadonly [string, string]

Returns

MiddlewareOrderingError

Overrides

GraphorinProviderError.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
canonicalOrderreadonlyreadonly string[]undefined---packages/provider/src/errors/errors.ts:43
cause?publicunknownundefined--GraphorinProviderError.causenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?readonlystringundefinedOptional remediation hint shown alongside the message.-GraphorinProviderError.hintpackages/provider/src/errors/errors.ts:21
kindreadonlystringundefinedStable discriminant — 'middleware-ordering', 'rate-limit-exceeded', …-GraphorinProviderError.kindpackages/provider/src/errors/errors.ts:19
messagepublicstringundefined--GraphorinProviderError.messagenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
namereadonly"MiddlewareOrderingError"'MiddlewareOrderingError'-GraphorinProviderError.name-packages/provider/src/errors/errors.ts:41
offendingPairreadonlyreadonly [string, string]undefined---packages/provider/src/errors/errors.ts:42
stack?publicstringundefined--GraphorinProviderError.stacknode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimitstaticnumberundefinedThe 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.stackTraceLimitnode_modules/.pnpm/@types+node@22.19.17/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

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

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

GraphorinProviderError.captureStackTrace


prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

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

GraphorinProviderError.prepareStackTrace