Class RuntimeError

Class representing a RuntimeError.

Author

Mr. Stone evensstone@gmail.com

Hierarchy (View Summary)

Error
- RuntimeError

Index

Constructors

Properties

cause? code? metadata?

Methods

toString create

Constructors

constructor

new RuntimeError(message: string, options?: ErrorOptions): RuntimeError
Create a RuntimeError.
Parameters
- message: string
  The message to log.
- options: ErrorOptions = {}
  The error options.
Returns RuntimeError

Overrides Error.constructor

Properties

`Optional` `Readonly`cause

cause?: Error

`Optional` `Readonly`code

code?: string

`Optional` `Readonly`metadata

metadata?: unknown

Methods

toString

toString(multiline?: boolean): string
Converts the error to a formatted string representation.
Parameters
- multiline: boolean = false
  Determine if output value must be multiline or not.
Returns string
A formatted error string.

`Static`create

create<T extends RuntimeError = RuntimeError>(
message: string,
options?: ErrorOptions,
): T
Create a RuntimeError.
Type Parameters
- T extends RuntimeError = RuntimeError
Parameters
- message: string
- options: ErrorOptions = {}
  The options to create a RuntimeError.
Returns T
A new RuntimeError instance.