Partager via

RestError class

Paquet:
@azure/core-http

Erreur résultant d’une requête HTTP vers un point de terminaison de service.

Extends

Error

Constructeurs

RestError(string, string, number, WebResourceLike, HttpOperationResponse)

Propriétés

code

Code d’erreur, le cas échéant. Il peut s’agir de l’une des propriétés du code d’erreur statique (REQUEST_SEND_ERROR/PARSE_ERROR) ou d’un code de chaîne à partir d’un appel système sous-jacent (E_NOENT).
details

Tous les détails supplémentaires. Dans le cas d’erreurs de désérialisation, il peut s’agir de la réponse traitée.
PARSE_ERROR

Chaîne constante permettant d’identifier les erreurs qui peuvent survenir lors de l’analyse d’une réponse HTTP entrante. Indique généralement un corps HTTP mal formé, tel qu’une charge utile JSON encodée incomplète.
request

Demande sortante.
REQUEST_SEND_ERROR

Chaîne constante permettant d’identifier les erreurs qui peuvent survenir lors de la création d’une requête HTTP qui indique un problème avec la couche de transport (par exemple, le nom d’hôte de l’URL ne peut pas être résolu via DNS.)
response

Réponse entrante.
statusCode

Code d’état HTTP de la réponse, si une réponse a été retournée.

Propriétés héritées

message
name
stack
stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 mais peut être définie sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

Méthodes héritées

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

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

La première ligne de la trace sera préfixée par ${myObject.name}: ${myObject.message}.

L’argument facultatif constructorOpt accepte une fonction. Si cette option est donnée, toutes les images au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Par exemple:

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[])

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

Détails du constructeur

RestError(string, string, number, WebResourceLike, HttpOperationResponse) 

new RestError(message: string, code?: string, statusCode?: number, request?: WebResourceLike, response?: HttpOperationResponse)

Paramètres

message

string

code

string

statusCode

number

request
WebResourceLike
response
HttpOperationResponse

Détails de la propriété

code

Code d’erreur, le cas échéant. Il peut s’agir de l’une des propriétés du code d’erreur statique (REQUEST_SEND_ERROR/PARSE_ERROR) ou d’un code de chaîne à partir d’un appel système sous-jacent (E_NOENT).

code?: string

Valeur de propriété

string

details

Tous les détails supplémentaires. Dans le cas d’erreurs de désérialisation, il peut s’agir de la réponse traitée.

details?: unknown

Valeur de propriété

unknown

PARSE_ERROR

Chaîne constante permettant d’identifier les erreurs qui peuvent survenir lors de l’analyse d’une réponse HTTP entrante. Indique généralement un corps HTTP mal formé, tel qu’une charge utile JSON encodée incomplète.

static PARSE_ERROR: string

Valeur de propriété

string

request

Demande sortante.

request?: WebResourceLike

Valeur de propriété

WebResourceLike

REQUEST_SEND_ERROR

Chaîne constante permettant d’identifier les erreurs qui peuvent survenir lors de la création d’une requête HTTP qui indique un problème avec la couche de transport (par exemple, le nom d’hôte de l’URL ne peut pas être résolu via DNS.)

static REQUEST_SEND_ERROR: string

Valeur de propriété

string

response

Réponse entrante.

response?: HttpOperationResponse

Valeur de propriété

HttpOperationResponse

statusCode

Code d’état HTTP de la réponse, si une réponse a été retournée.

statusCode?: number

Valeur de propriété

number

Détails de la propriété héritée

message 

message: string

Valeur de propriété

string

héritée de Error.message

name 

name: string

Valeur de propriété

string

héritée de Error.name

stack 

stack?: string

Valeur de propriété

string

héritée de Error.stack

stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 mais peut être définie sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

static stackTraceLimit: number

Valeur de propriété

number

héritée de Error.stackTraceLimit

Détails de la méthode héritée

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

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

La première ligne de la trace sera préfixée par ${myObject.name}: ${myObject.message}.

L’argument facultatif constructorOpt accepte une fonction. Si cette option est donnée, toutes les images au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Par exemple:

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)

Paramètres

targetObject

object

constructorOpt

Function

héritée de Error.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Paramètres

err

Error

stackTraces

CallSite[]

Retours

any

héritée de Error.prepareStackTrace