Class Err

An Err is synonymous with undefined. undefined means that the types are correct but the expression is not meaningful because of the values. An error that may be used as a return value. This MUST not be thrown. Err may be considered to be synonymous with undefined.

Hierarchy

Error
- Err

Implements

Atom

Index

Constructors

constructor

new Err(message, cause?, pos?, end?): Err
Parameters
- message: U
- Optional cause: Err
- Optional pos: number
- Optional end: number
Returns Err
Overrides Error.constructor
- Defined in packages/atoms/src/err/Err.ts:17

Properties

`Optional` cause

cause?: unknown

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` type

type: "error" = "error"

`Static` `Optional` prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

- (err, stackTraces): any
- Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

See

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

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

end

get end(): number
Returns number
Implementation of Atom.end
- Defined in packages/atoms/src/err/Err.ts:47

iscons

get iscons(): false
Returns false
Implementation of Atom.iscons
- Defined in packages/atoms/src/err/Err.ts:62

isnil

get isnil(): false
Returns false
Implementation of Atom.isnil
- Defined in packages/atoms/src/err/Err.ts:65

originalCause

get originalCause(): Err
Returns Err
- Defined in packages/atoms/src/err/Err.ts:36

originalMessage

get originalMessage(): U
Returns U
- Defined in packages/atoms/src/err/Err.ts:32

pos

get pos(): number
Returns number
Implementation of Atom.pos
- Defined in packages/atoms/src/err/Err.ts:44

Methods

addRef

addRef(): void
Returns void
Implementation of Atom.addRef
- Defined in packages/atoms/src/err/Err.ts:50

contains

contains(needle): boolean
Parameters
- needle: U
Returns boolean
Implementation of Atom.contains
- Defined in packages/atoms/src/err/Err.ts:29

equals

equals(other): boolean
Parameters
- other: U
Returns boolean
Implementation of Atom.equals
- Defined in packages/atoms/src/err/Err.ts:68

equalsErr

equalsErr(other): boolean
Parameters
- other: Err
Returns boolean
- Defined in packages/atoms/src/err/Err.ts:78

release

release(): void
Returns void
Implementation of Atom.release
- Defined in packages/atoms/src/err/Err.ts:53

toInfixString

toInfixString(): string
Returns string
- Defined in packages/atoms/src/err/Err.ts:84

toListString

toListString(): string
Returns string
- Defined in packages/atoms/src/err/Err.ts:87

toString

toString(): string
Returns string
- Defined in packages/atoms/src/err/Err.ts:81

`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/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:21

Class Err

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Err

Properties

Optional cause

message

name

Optional stack

Readonly type

Static Optional prepareStackTrace

Type declaration

Parameters

Returns any

See

Static stackTraceLimit

Accessors

end

Returns number

iscons

Returns false

isnil

Returns false

originalCause

Returns Err

originalMessage

Returns U

pos

Returns number

Methods

addRef

Returns void

contains

Parameters

Returns boolean

equals

Parameters

Returns boolean

equalsErr

Parameters

Returns boolean

release

Returns void

toInfixString

Returns string

toListString

Returns string

toString

Returns string

Static captureStackTrace

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` cause

`Optional` stack

`Readonly` type

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` captureStackTrace