NotFoundError
Defined in: errors.ts:123
Thrown when the Obol API responds with 404.
Extends​
Indexable​
[
key:string]:unknown
Additional fields copied from the error body.
Properties​
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
status | public | number | HTTP status code of the response. | ObolApiError.status | errors.ts:53 |
endpoint | public | string | Request path relative to the base URL. | ObolApiError.endpoint | errors.ts:55 |
method | public | string | HTTP method of the request. | ObolApiError.method | errors.ts:57 |
body | public | unknown | Parsed JSON error body, or the raw text when the body is not JSON. | ObolApiError.body | errors.ts:59 |
hint? | public | string | Short, actionable suggestion for the caller. | ObolApiError.hint | errors.ts:61 |
requestId? | public | string | The response's X-Request-Id header, when present. Quote it when reporting a failed request to Obol so it can be found in the API logs. | ObolApiError.requestId | errors.ts:66 |
statusCode? | public | number | Status code reported in the error body (Obol API errors include it). | ObolApiError.statusCode | errors.ts:68 |
stackTraceLimit | static | number | 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. | ObolApiError.stackTraceLimit | node_modules/@types/node/globals.d.ts:68 |
Methods​
captureStackTrace()​
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:52
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();
Parameters​
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns​
void
Inherited from​
ObolApiError.captureStackTrace
prepareStackTrace()​
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:56
Parameters​
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns​
any
See​
https://v8.dev/docs/stack-trace-api#customizing-stack-traces