Builds the error from the response triplet plus an optional snapshot of the request that produced it.
Human-readable error description.
Response triplet plus an optional request snapshot.
Optionalcause?: unknownOriginal error that triggered this one.
Optionalconfig?: HttpErrorRequestConfigSnapshot of the request that triggered the error.
Optionalredaction?: RedactionRedaction engine carrying the consumer's sensitive-key vocabulary.
Normalized response that carried the non-2xx status.
Parsed (or raw text) response body.
HTTP headers, multi-valued set-cookie preserved as an array.
HTTP status code.
OptionalcauseOptional ReadonlyconfigReadonlyisReadonlyresponseOptionalstackStaticstackThe 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.
StaticcaptureCreates 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();
OptionalconstructorOpt: FunctionStaticisIndicates whether the argument provided is a built-in Error instance or not.
Staticprepare
Thrown by HttpClient whenever an upstream response has a non-2xx status. The shape mirrors what downstream code needs:
response.status,response.headers, andresponse.data.Both halves are redacted: a failed response body is a DIAGNOSTIC payload, not a contract — upstreams echo the credential they just rejected, and the SDKs' own loggers have always blanked it. It is therefore typed
unknown, since nothing may rely on the shape of a value whose secrets have been replaced.The vocabulary the redaction applies is the injected Redaction — the consuming SDK passes the engine bound to its wire's credential keys; without one, the base vocabulary applies.