Skip to main content

Class: InvalidShardIdError

The error class for invalid shard ID. This error is thrown when the provided shard ID is invalid.

Extends​

Constructors​

new InvalidShardIdError()​

new InvalidShardIdError(param0): InvalidShardIdError

Creates an instance of InvalidShardIdError.

Parameters​

ParameterTypeDescription

param0

InvalidShardIdErrorParameters

The error params.

Returns​

InvalidShardIdError

Overrides​

BaseError.constructor

Defined​

@nilfoundation/niljs/src/errors/shardId.ts:23

Properties​

cause?​

optional cause: BaseError | Error;

The error cause.

Inherited from​

BaseError.cause

Defined​

@nilfoundation/niljs/src/errors/BaseError.ts:42

docsPath?​

optional docsPath: string;

The path to the documentation of this error.

Inherited from​

BaseError.docsPath

Defined​

@nilfoundation/niljs/src/errors/BaseError.ts:49

isOperational​

isOperational: boolean;

The flag that indicates if this error is operational. This is useful to differentiate operational errors from programming errors. It is recommended to always set this property to true when creating a custom error class.

Inherited from​

BaseError.isOperational

Defined​

@nilfoundation/niljs/src/errors/BaseError.ts:35

message​

message: string;

Inherited from​

BaseError.message

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1077

name​

name: string;

Inherited from​

BaseError.name

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1076

stack?​

optional stack: string;

Inherited from​

BaseError.stack

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1078

version?​

optional version: string;

The version of the client.

Inherited from​

BaseError.version

Defined​

@nilfoundation/niljs/src/errors/BaseError.ts:53