Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/security / / OAuthCallbackError

Class: OAuthCallbackError

Defined in: packages/security/src/oauth/errors.ts:111

Thrown when the localhost callback handler receives a request that does not match the original PKCE verifier / state parameter.

Stable

Extends

Constructors

Constructor

ts
new OAuthCallbackError(message, options?): OAuthCallbackError;

Defined in: packages/security/src/oauth/errors.ts:112

Parameters

ParameterType
messagestring
options{ cause?: unknown; }
options.cause?unknown

Returns

OAuthCallbackError

Overrides

GraphorinOAuthError.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
cause?publicunknown-GraphorinOAuthError.causenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
hint?readonlystring-GraphorinOAuthError.hintpackages/security/src/oauth/errors.ts:17
kindreadonlystring-GraphorinOAuthError.kindpackages/security/src/oauth/errors.ts:16
messagepublicstring-GraphorinOAuthError.messagenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-GraphorinOAuthError.namenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-GraphorinOAuthError.stacknode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
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.GraphorinOAuthError.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

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

GraphorinOAuthError.prepareStackTrace