NetworkError class
Error for network-related issues (e.g., API unreachable, bad response).
- Extends
Constructors
| Network |
Properties
| consent |
URL the signed-in user must visit to authorize a delegated connector, when
the service answered |
| name | |
| retry |
Seconds the service asked the caller to wait before retrying, from the
response body or the |
| server |
Machine-readable error code from the response body ( Separate from SdkError.code so existing branches on |
| status | HTTP status code associated with the failed response, when available. |
| workload | Structured detail from a Fabric workload failure envelope, when the response carried one. Kept as fields rather than only folded into |
Inherited Properties
| code | Optional stable, machine-readable error code. |
| message | |
| stack | |
| stack |
The The default value is If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
Inherited Methods
| capture |
Creates a
The first line of the trace will be prefixed with
The optional The
|
| prepare |
See https://v8.dev/docs/stack-trace-api#customizing-stack-traces |
Constructor Details
NetworkError(string, number, string)
new NetworkError(message: string, status?: number, code?: string)
Parameters
- message
-
string
Human-readable error description.
- status
-
number
HTTP status code associated with the failed response.
- code
-
string
Optional stable, machine-readable error code.
Property Details
consentUrl
URL the signed-in user must visit to authorize a delegated connector, when
the service answered CONNECTOR_CONSENT_REQUIRED.
consentUrl?: string
Property Value
string
name
name: string
Property Value
string
retryAfterSeconds
Seconds the service asked the caller to wait before retrying, from the
response body or the Retry-After header.
retryAfterSeconds?: number
Property Value
number
serverErrorCode
Machine-readable error code from the response body (error,
error.code, or errorCode), when the service sent one.
Separate from SdkError.code so existing branches on code are
unaffected.
serverErrorCode?: string
Property Value
string
status
HTTP status code associated with the failed response, when available.
status?: number
Property Value
number
workload
Structured detail from a Fabric workload failure envelope, when the response carried one.
Kept as fields rather than only folded into message so callers can branch
on the failure shape instead of matching message substrings.
workload?: WorkloadFailure
Property Value
Inherited Property Details
code
Optional stable, machine-readable error code.
code?: string
Property Value
string
Inherited From SdkError.code
message
stack
stackTraceLimit
The 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.
static stackTraceLimit: number
Property Value
number
Inherited From SdkError.stackTraceLimit
Inherited Method Details
captureStackTrace(object, Function)
Creates 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();
static function captureStackTrace(targetObject: object, constructorOpt?: Function)
Parameters
- targetObject
-
object
- constructorOpt
-
Function
Inherited From SdkError.captureStackTrace
prepareStackTrace(Error, CallSite[])
See https://v8.dev/docs/stack-trace-api#customizing-stack-traces
static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any
Parameters
- err
-
Error
- stackTraces
-
CallSite[]
Returns
any
Inherited From SdkError.prepareStackTrace