Skip to content

ShardlensClientError

Defined in: packages/client/src/errors.ts:5

Every failure of the client: an answer other than 2xx, no answer at all, or options it can’t work with. The message never contains the key.

  • Error

new ShardlensClientError(message, details): ShardlensClientError

Defined in: packages/client/src/errors.ts:19

string

unknown

string

string

number

number

ShardlensClientError

Error.constructor

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Error.cause


readonly code: string

Defined in: packages/client/src/errors.ts:13

The collector’s error code (unauthorized, invalid_query, activity_key_required, audit_mode_off, rate_limited…), or http_<status> for an answer without one. Without an answer: timeout, network or invalid_options. invalid_response is a 2xx answer that isn’t the collector’s JSON.


message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Error.message


name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Error.name


readonly requestId: string | undefined

Defined in: packages/client/src/errors.ts:17

The collector’s ID for a request it failed on (a 500), to find it in the collector’s log.


readonly retryAfterSeconds: number | undefined

Defined in: packages/client/src/errors.ts:15

How long the collector asks to wait before trying again, from Retry-After (a 429, or a busy live stream).


optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Error.stack


readonly status: number

Defined in: packages/client/src/errors.ts:7

The HTTP status of the collector’s answer. 0 when there was none: a timeout, a network failure, bad options.


static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.19.2/node_modules/@types/node/globals.d.ts:68

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.

Error.stackTraceLimit

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@24.19.2/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();

object

Function

void

Error.captureStackTrace


static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@24.19.2/node_modules/@types/node/globals.d.ts:56

Error

CallSite[]

any

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Error.prepareStackTrace