Class CIDLangError

Base error for all cid errors

Hierarchy

Error
- CIDLangError
  - CIDLangSyntaxError
  - CIDLangRuntimeError

Index

Constructors

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isError isExitError isRuntimeError isSyntaxError

Constructors

constructor

new CIDLangError(message?): CIDLangError
Parameters
- Optional message: string
Returns CIDLangError
Inherited from Error.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1059
new CIDLangError(message?, options?): CIDLangError
Parameters
- Optional message: string
- Optional options: ErrorOptions
Returns CIDLangError
Inherited from Error.constructor
- Defined in node_modules/typescript/lib/lib.es2022.error.d.ts:30

Properties

`Optional` cause

cause?: unknown

message

message: string

name

name: string

`Optional` stack

stack?: string

`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

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

`Static` isError

isError(value): value is CIDLangError
Check if value is a CID error
Parameters
- value: unknown
  
  Value to check
Returns value is CIDLangError
If value is a CID error
- Defined in packages/lib/src/errors.ts:10

`Static` isExitError

isExitError(value): value is CIDLangExitError
Check if value is a CID exit error
Parameters
- value: unknown
  
  Value to check
Returns value is CIDLangExitError
If value is a CID exit error
- Defined in packages/lib/src/errors.ts:37

`Static` isRuntimeError

isRuntimeError(value): value is CIDLangRuntimeError
Check if value is a CID runtime error
Parameters
- value: unknown
  
  Value to check
Returns value is CIDLangRuntimeError
If value is a CID runtime error
- Defined in packages/lib/src/errors.ts:28

`Static` isSyntaxError

isSyntaxError(value): value is CIDLangSyntaxError
Check if value is a CID syntax error
Parameters
- value: unknown
  
  Value to check
Returns value is CIDLangSyntaxError
If value is a CID syntax error
- Defined in packages/lib/src/errors.ts:19

Generated using TypeDoc