RestError class

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Rozszerzenie

Error

Konstruktory

RestError(string, RestErrorOptions)

Właściwości

code

Kod samego błędu (jeśli jest to możliwe, użyj statycznych funkcji RestError).

details

Właściwość bonusowa ustawiona przez witrynę rzutu.

PARSE_ERROR

Oznacza to, że analizowanie odpowiedzi z serwera nie powiodło się. Mogło to być źle sformułowane.

request

Żądanie, które zostało złożone.

REQUEST_SEND_ERROR

Wystąpił problem podczas tworzenia żądania. Oznacza to, że rzeczywiste żądanie nie powiodło się z jakiegoś powodu, na przykład problem z systemem DNS lub utracono połączenie.

response

Odebrano odpowiedź (jeśli istnieje).

statusCode

Kod stanu HTTP żądania (jeśli dotyczy).

Właściwości dziedziczone

message
name
stack
stackTraceLimit

Właściwość Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy jest generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Wartość domyślna to 10 ale może być ustawiona na dowolny prawidłowy numer JavaScript. Zmiany będą miały wpływ na wszystkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawiona jest wartość inna niż liczba lub liczba ujemna, ślady stosu nie będą przechwytywać żadnych ramek.

Metody dziedziczone

captureStackTrace(object, Function)

Tworzy właściwość .stack w programie targetObject, która po uzyskaniu dostępu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() została wywołana.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

Pierwszy wiersz śladu będzie poprzedzony prefiksem ${myObject.name}: ${myObject.message}.

constructorOpt Opcjonalny argument akceptuje funkcję. Jeśli zostanie podana, wszystkie klatki powyżej constructorOpt, w tym constructorOpt, zostaną pominięte w wygenerowanym śladzie stosu.

Argument constructorOpt jest przydatny do ukrywania szczegółów implementacji generowania błędów przed użytkownikiem. Przykład:

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();
prepareStackTrace(Error, CallSite[])

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

Szczegóły konstruktora

RestError(string, RestErrorOptions)

new RestError(message: string, options?: RestErrorOptions)

Parametry

message

string

Szczegóły właściwości

code

Kod samego błędu (jeśli jest to możliwe, użyj statycznych funkcji RestError).

code?: string

Wartość właściwości

string

details

Właściwość bonusowa ustawiona przez witrynę rzutu.

details?: unknown

Wartość właściwości

unknown

PARSE_ERROR

Oznacza to, że analizowanie odpowiedzi z serwera nie powiodło się. Mogło to być źle sformułowane.

static PARSE_ERROR: string

Wartość właściwości

string

request

Żądanie, które zostało złożone.

request?: PipelineRequest

Wartość właściwości

REQUEST_SEND_ERROR

Wystąpił problem podczas tworzenia żądania. Oznacza to, że rzeczywiste żądanie nie powiodło się z jakiegoś powodu, na przykład problem z systemem DNS lub utracono połączenie.

static REQUEST_SEND_ERROR: string

Wartość właściwości

string

response

Odebrano odpowiedź (jeśli istnieje).

response?: PipelineResponse

Wartość właściwości

statusCode

Kod stanu HTTP żądania (jeśli dotyczy).

statusCode?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

message

message: string

Wartość właściwości

string

dziedziczone z Error.message

name

name: string

Wartość właściwości

string

dziedziczone z Error.name

stack

stack?: string

Wartość właściwości

string

dziedziczone z Error.stack

stackTraceLimit

Właściwość Error.stackTraceLimit określa liczbę ramek stosu zebranych przez ślad stosu (niezależnie od tego, czy jest generowany przez new Error().stack lub Error.captureStackTrace(obj)).

Wartość domyślna to 10 ale może być ustawiona na dowolny prawidłowy numer JavaScript. Zmiany będą miały wpływ na wszystkie ślady stosu przechwycone po zmianie wartości.

Jeśli ustawiona jest wartość inna niż liczba lub liczba ujemna, ślady stosu nie będą przechwytywać żadnych ramek.

static stackTraceLimit: number

Wartość właściwości

number

dziedziczone z Error.stackTraceLimit

Szczegóły metody dziedziczonej

captureStackTrace(object, Function)

Tworzy właściwość .stack w programie targetObject, która po uzyskaniu dostępu zwraca ciąg reprezentujący lokalizację w kodzie, w którym Error.captureStackTrace() została wywołana.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

Pierwszy wiersz śladu będzie poprzedzony prefiksem ${myObject.name}: ${myObject.message}.

constructorOpt Opcjonalny argument akceptuje funkcję. Jeśli zostanie podana, wszystkie klatki powyżej constructorOpt, w tym constructorOpt, zostaną pominięte w wygenerowanym śladzie stosu.

Argument constructorOpt jest przydatny do ukrywania szczegółów implementacji generowania błędów przed użytkownikiem. Przykład:

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();
static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Parametry

targetObject

object

constructorOpt

Function

dziedziczone z Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parametry

err

Error

stackTraces

CallSite[]

Zwraca

any

dziedziczone z Error.prepareStackTrace