Human-readable error description
Machine-readable error code
OptionalgraphQLErrors: GraphQLError[]Errors returned in the GraphQL response errors array
Optionalrequest: GraphQLRequest<Record<string, unknown>>The GraphQL request that triggered the error
Optionalresponse: GraphQLResponse<unknown>The (partial) GraphQL response, if available
OptionalnetworkError: unknownUnderlying network / transport error, if applicable
StaticstackThe 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.
ReadonlycodeMachine-readable error code (e.g. "EGRAPHQL", "ENETWORK", "ETIMEOUT")
Optional ReadonlygraphErrors returned in the GraphQL response errors array
Optional ReadonlyrequestThe GraphQL request that triggered the error
Optional ReadonlyresponseThe (partial) GraphQL response, if available
Optional ReadonlynetworkUnderlying network / transport error, if applicable
OptionalcauseOptionalstackTrue if the error contains GraphQL-layer errors (not network).
True if the error is a network/transport error.
Return the first error message from the GraphQL errors array.
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: FunctionStaticprepare
Error raised by the GraphQL client for network failures, GraphQL-layer errors, response parse failures, timeouts, and missing data.
Use the isGraphQLError / isNetworkError getters to distinguish error categories.