メインコンテンツにスキップ
バージョン: 0.2.0-beta.1

クラス: MCPAuthError

すべての mcp-auth エラーの基底クラスです。

MCP の認証 (Authentication) および認可 (Authorization) に関連するエラーを標準化された方法で処理する手段を提供します。

継承元

  • Error

このクラスを継承するクラス

コンストラクター

コンストラクター

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

パラメーター

code

string

スネークケース形式のエラーコード。

message

string

エラーの人間が読める説明。

戻り値

MCPAuthError

オーバーライド元

Error.constructor

プロパティ

cause?

optional cause: unknown;

継承元

Error.cause

code

readonly code: string;

スネークケース形式のエラーコード。


message

message: string;

継承元

Error.message

name

name: string = 'MCPAuthError';

オーバーライド元

Error.name

stack?

optional stack: string;

継承元

Error.stack

stackTraceLimit

static stackTraceLimit: number;

Error.stackTraceLimit プロパティは、スタックトレース(new Error().stack または Error.captureStackTrace(obj) で生成される)によって収集されるスタックフレームの数を指定します。

デフォルト値は 10 ですが、有効な JavaScript の数値であれば任意に設定できます。値を変更した後にキャプチャされるすべてのスタックトレースに影響します。

数値以外や負の数値を設定した場合、スタックトレースはフレームをキャプチャしません。

継承元

Error.stackTraceLimit

メソッド

toJson()

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

エラーを HTTP レスポンスに適した JSON 形式に変換します。

パラメーター

showCause

boolean = false

JSON レスポンスにエラーの原因を含めるかどうか。 デフォルトは false です。

戻り値

Record<string, unknown>


captureStackTrace()

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

targetObject.stack プロパティを作成し、アクセス時に Error.captureStackTrace() が呼び出されたコード位置を表す文字列を返します。

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // `new Error().stack` と同様

トレースの最初の行は ${myObject.name}: ${myObject.message} で始まります。

オプションの constructorOpt 引数には関数を指定できます。指定した場合、constructorOpt より上のすべてのフレーム(constructorOpt を含む)は生成されたスタックトレースから省略されます。

constructorOpt 引数は、エラー生成の実装詳細をユーザーから隠すのに便利です。例:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // スタックトレースを二重に計算しないように、スタックトレースなしでエラーを作成
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // 関数 b より上のスタックトレースをキャプチャ
  Error.captureStackTrace(error, b); // c と b はスタックトレースに含まれません
  throw error;
}

a();

パラメーター

targetObject

object

constructorOpt?

Function

戻り値

void

継承元

Error.captureStackTrace

prepareStackTrace()

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

パラメーター

err

Error

stackTraces

CallSite[]

戻り値

any

参考

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

継承元

Error.prepareStackTrace