Skip to main content
Version: 0.2.0-beta.1

Class: MCPAuthConfigError

Error thrown when there is a configuration issue with mcp-auth.

Extends

Constructors

Constructor

new MCPAuthConfigError(code: string, message: string): MCPAuthConfigError;

Parameters

code

string

The error code in snake_case format.

message

string

A human-readable description of the error.

Returns

MCPAuthConfigError

Inherited from

MCPAuthError.constructor

Properties

cause?

optional cause: unknown;

Inherited from

MCPAuthError.cause


code

readonly code: string;

The error code in snake_case format.

Inherited from

MCPAuthError.code


message

message: string;

Inherited from

MCPAuthError.message


name

name: string = 'MCPAuthConfigError';

Overrides

MCPAuthError.name


stack?

optional stack: string;

Inherited from

MCPAuthError.stack


stackTraceLimit

static stackTraceLimit: number;

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.

Inherited from

MCPAuthError.stackTraceLimit

Methods

toJson()

toJson(showCause: boolean): Record<string, unknown>;

Converts the error to a HTTP response friendly JSON format.

Parameters

showCause

boolean = false

Whether to include the cause of the error in the JSON response. Defaults to false.

Returns

Record<string, unknown>

Inherited from

MCPAuthError.toJson


captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

MCPAuthError.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

MCPAuthError.prepareStackTrace