Errors keyed by field, as parse returns them. The message is derived from them, so the two cannot disagree.
The request and response that produced them.
OptionalcauseReadonlyerrorsOptional ReadonlyrequestOptional ReadonlyresponseOptionalstackOptional ReadonlystatusOptional ReadonlystatusStaticstackThe 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: FunctionStaticparseReads a response body as validation errors, or returns undefined when it
is not that shape, leaving the caller to fall back.
The bodies nest: a field maps either to its messages or to its own fields,
so {"size": {"non_field_errors": [...]}} is a complaint about size
itself. Those segments are dropped, since they name the level above rather
than a field of it, which leaves nonFieldErrors only ever at the root.
Anything deeper is flattened to a dotted path, and every segment is
camelized except one naming the caller's own metadata.
A parsed response body.
Errors keyed by field, or undefined when the body is shaped some
other way.
Staticprepare
A request rejected for its contents rather than for what it addressed:
POST /files/search/answers this way when a condition is malformed or missing.It extends RestClientError, so code that catches that keeps working and
status,requestandresponseare where they always were. What it adds is errors: the server's complaints keyed by field, for callers that want to react per field instead of reading the message.Example