Moss SDK Documentation

Appearance

@inferedge/moss-clustering v1.0.0-beta.3

@inferedge/moss-clustering / ClusteringError

Class: ClusteringError ​

Custom error class for clustering operations

Extends ​

  • Error

Constructors ​

Constructor ​

new ClusteringError(code, message, statusCode?): ClusteringError

Creates a new ClusteringError

Parameters ​

code ​

string

Error code from ClusteringErrorCode enum

message ​

string

Human-readable error message

statusCode? ​

number

HTTP status code (optional)

Returns ​

ClusteringError

Overrides ​

Error.constructor

Properties ​

code ​

readonly code: string

Error code for programmatic error handling

statusCode? ​

readonly optional statusCode: number

HTTP status code (if applicable)

stackTraceLimit ​

static stackTraceLimit: 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.

Inherited from ​

Error.stackTraceLimit

cause? ​

optional cause: unknown

Inherited from ​

Error.cause

name ​

name: string

Inherited from ​

Error.name

message ​

message: string

Inherited from ​

Error.message

stack? ​

optional stack: string

Inherited from ​

Error.stack

Methods ​

fromResponse() ​

static fromResponse(status, responseText): ClusteringError

Creates a ClusteringError from an HTTP response

Parameters ​

status ​

number

responseText ​

string

Returns ​

ClusteringError

networkError() ​

static networkError(originalError): ClusteringError

Creates a ClusteringError for network failures

Parameters ​

originalError ​

Error

Returns ​

ClusteringError

noClusteringFound() ​

static noClusteringFound(): ClusteringError

Creates a ClusteringError for missing clustering

Returns ​

ClusteringError

invalidK() ​

static invalidK(k): ClusteringError

Creates a ClusteringError for invalid k value

Parameters ​

k ​

number

Returns ​

ClusteringError

isClusteringError() ​

static isClusteringError(error): error is ClusteringError

Checks if an error is a ClusteringError

Parameters ​

error ​

any

Returns ​

error is ClusteringError

toJSON() ​

toJSON(): Record<string, any>

Returns a JSON representation of the error

Returns ​

Record<string, any>

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
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:

js
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 ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

Error.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

Error.prepareStackTrace