Class Error

Hierarchy

Error
- Error

Index

Constructors

constructor

new Error(message?: string): Scrt.Error
Parameters
- Optional message: string
Returns Scrt.Error
Inherited from Error.constructor
- Defined in node_modules/.pnpm/typescript@5.0.2/node_modules/typescript/lib/lib.es5.d.ts:1060

Properties

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` Failed

Failed: typeof FadromaError_Failed

Thrown when an operation fails.

`Static` Invalid

Invalid: typeof FadromaError_Invalid

Thrown when an invalid value or operation is at hand.

`Static` Missing

Missing: typeof FadromaError_Missing

Thrown when a required parameter is missing.

`Static` Unimplemented

Unimplemented: typeof OopsError = ...

Thrown when the control flow reaches unimplemented areas.

`Static` Unsupported

Unsupported: typeof FadromaError_Unsupported

Thrown when unsupported functionality is requested.

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): 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.3.3/node_modules/@types/node/globals.d.ts:4

`Static` define

define<T>(name: string, getMessage?: string | ((...args: T) => string), construct?: ((self: Error, ...args: T) => any)): typeof OopsError
Define an error subclass.
Type Parameters
- T extends unknown[]
Parameters
- name: string
  
  Name of error class. Prepended to parent.
- getMessage: string | ((...args: T) => string) = ...
  
  How to generate the error message from the arguments passed to the constructor.
- Optional construct: ((self: Error, ...args: T) => any)
  
  Whether there are any further construction steps such as assigning properties.
  - - (self: Error, ...args: T): any
    - Whether there are any further construction steps such as assigning properties.
      
      Parameters
      
      self: Error
      
      Rest ...args: T
      
      Returns any
Returns typeof OopsError
Inherited from Error.define
- Defined in ensuite/toolbox/oops/oops.ts:6

Class Error

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional message: string

Returns Scrt.Error

Properties

message

name

Optional stack

Static Failed

Static Invalid

Static Missing

Static Unimplemented

Static Unsupported

Static Optional prepareStackTrace

Type declaration

See

Parameters

err: Error

stackTraces: CallSite[]

Returns any

Static stackTraceLimit

Methods

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Static define

Type Parameters

T extends unknown[]

Parameters

name: string

getMessage: string | ((...args: T) => string) = ...

Optional construct: ((self: Error, ...args: T) => any)

Parameters

self: Error

Rest ...args: T

Returns any

Returns typeof OopsError

Settings

Member Visibility

Theme

`Optional` message: string

`Optional` stack

`Static` Failed

`Static` Invalid

`Static` Missing

`Static` Unimplemented

`Static` Unsupported

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` define

`Optional` construct: ((self: Error, ...args: T) => any)

`Rest` ...args: T