Pular para o conteúdo principal
Versão: 0.2.0-beta.1

Classe: MCPAuthError

Classe base para todos os erros do mcp-auth.

Ela fornece uma maneira padronizada de lidar com erros relacionados à autenticação (Authentication) e autorização (Authorization) MCP.

Estende​

  • Error

Estendida por​

Construtores​

Construtor​

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

Parâmetros​

code​

string

O código do erro no formato snake_case.

message​

string

Uma descrição legível do erro.

Retorna​

MCPAuthError

Sobrescreve​

Error.constructor

Propriedades​

cause?​

optional cause: unknown;

Herdado de​

Error.cause

code​

readonly code: string;

O código do erro no formato snake_case.

message​

message: string;

Herdado de​

Error.message

name​

name: string = 'MCPAuthError';

Sobrescreve​

Error.name

stack?​

optional stack: string;

Herdado de​

Error.stack

stackTraceLimit​

static stackTraceLimit: number;

A propriedade Error.stackTraceLimit especifica o número de frames de pilha coletados por um stack trace (seja gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10, mas pode ser definido para qualquer número válido do JavaScript. Alterações afetarão qualquer stack trace capturado após a alteração do valor.

Se definido para um valor não numérico, ou para um número negativo, os stack traces não capturarão nenhum frame.

Herdado de​

Error.stackTraceLimit

Métodos​

toJson()​

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

Converte o erro para um formato JSON amigável para resposta HTTP.

Parâmetros​

showCause​

boolean = false

Se deve incluir a causa do erro na resposta JSON. O padrão é false.

Retorna​

Record<string, unknown>

captureStackTrace()​

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

Cria uma propriedade .stack em targetObject, que ao ser acessada retorna uma string representando a localização no código em que Error.captureStackTrace() foi chamada.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Semelhante a `new Error().stack`

A primeira linha do trace será prefixada com ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se fornecido, todos os frames acima de constructorOpt, incluindo constructorOpt, serão omitidos do stack trace gerado.

O argumento constructorOpt é útil para ocultar detalhes de implementação da geração do erro para o usuário. Por exemplo:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Cria um erro sem stack trace para evitar calcular o stack trace duas vezes.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Captura o stack trace acima da função b
  Error.captureStackTrace(error, b); // Nem a função c, nem b são incluídas no stack trace
  throw error;
}

a();

Parâmetros​

targetObject​

object

constructorOpt?​

Function

Retorna​

void

Herdado de​

Error.captureStackTrace

prepareStackTrace()​

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

Parâmetros​

err​

Error

stackTraces​

CallSite[]

Retorna​

any

Veja​

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

Herdado de​

Error.prepareStackTrace