Class CIDLangExitError

An error thrown by the built in function exit

This allows the cid language to exit the process with exit code

Hierarchy

CIDLangRuntimeError
- CIDLangExitError

Index

Constructors

Properties

cause? exitCode message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isError isExitError isRuntimeError isSyntaxError

Constructors

constructor

new CIDLangExitError(exitCode): CIDLangExitError
Parameters
- exitCode: number
Returns CIDLangExitError
Overrides CIDLangRuntimeError.constructor
- Defined in packages/lib/src/errors.ts:76

Properties

`Optional` cause

cause?: unknown

exitCode

exitCode: number

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 CIDLangRuntimeError.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
Inherited from CIDLangRuntimeError.isError
- 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
Inherited from CIDLangRuntimeError.isExitError
- 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
Inherited from CIDLangRuntimeError.isRuntimeError
- 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
Inherited from CIDLangRuntimeError.isSyntaxError
- Defined in packages/lib/src/errors.ts:19

Generated using TypeDoc