Class AresError<Code>

Represents an error that is thrown by the client.

Type Parameters

Code extends LogErrorMessagesCodes = LogErrorMessagesCodes

Hierarchy

Error
- AresError

Index

Constructors

Properties

prepareStackTrace? stackTraceLimit code name message stack? cause?

Methods

captureStackTrace

Constructors

constructor

new AresError<Code>(scope, code, ...args): AresError<Code>
Type Parameters
- Code extends LogErrorMessagesCodes = LogErrorMessagesCodes
Parameters
- scope: null | LogScopes
- code: Code
- Rest ...args: Parameters<{
      400: (() => string);
      401: ((strArg) => string);
      402: ((methodName) => string);
      403: ((dirPath) => string);
  }[Code]>
Returns AresError<Code>
Overrides Error.constructor
- Defined in src/lib/classes/error.ts:13

Properties

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

`Readonly` code

code: "TEST" | "TESTARGS" | "MethodNotImplemented" | "InvalidDirPath"

name

name: string

message

message: string

`Optional` stack

stack?: string

`Optional` cause

cause?: unknown

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc