Class: UnknownMetricError

Defined in: server/insights/errors.ts:109

runMetric (or a dashboard tile) referenced a metric key that isn't registered.

ExtendsCopy Anchor Link

• InsightsError

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

new UnknownMetricError(metricKey: string): UnknownMetricError;

Defined in: server/insights/errors.ts:111

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

UnknownMetricError

OverridesCopy Anchor Link

InsightsError.constructor

PropertiesCopy Anchor Link

cause?Copy Anchor Link

optional cause?: unknown;

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

Inherited fromCopy Anchor Link

InsightsError.cause

codeCopy Anchor Link

readonly code: "UNKNOWN_METRIC" = "UNKNOWN_METRIC";

Defined in: server/insights/errors.ts:110

OverridesCopy Anchor Link

InsightsError.code

messageCopy Anchor Link

message: string;

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

Inherited fromCopy Anchor Link

InsightsError.message

metricKeyCopy Anchor Link

readonly metricKey: string;

Defined in: server/insights/errors.ts:111

nameCopy Anchor Link

name: string;

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

Inherited fromCopy Anchor Link

InsightsError.name

stack?Copy Anchor Link

optional stack?: string;

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

Inherited fromCopy Anchor Link

InsightsError.stack

stackTraceLimitCopy Anchor Link

static stackTraceLimit: number;

Defined in: ../node_modules/.pnpm/@types+node@24.13.3/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.

Inherited fromCopy Anchor Link

InsightsError.stackTraceLimit

MethodsCopy Anchor Link

captureStackTrace()Copy Anchor Link

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

Inherited fromCopy Anchor Link

InsightsError.captureStackTrace

prepareStackTrace()Copy Anchor Link

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

any

SeeCopy Anchor Link

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

Inherited fromCopy Anchor Link

InsightsError.prepareStackTrace