Class FuseError

A structured error object.

Hierarchy

Error
- FuseError

Implements

ISerializable

Index

Constructors

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

getCause getCode getDomain getMessage serialize toString captureStackTrace fromSerialized wrap

Constructors

constructor

new FuseError(
    domain: string,
    message: string,
    cause?: TFuseErrorCause,
    code?: number,
): FuseError
Parameters
- domain: string
  The error domain, usually represents a library, class, or plugin.
- message: string
  The error message
- Optionalcause: TFuseErrorCause
  The underlying cause of the error. May be null.
- Optionalcode: number
  An error code. May be null.
Returns FuseError
Overrides Error.constructor
- Defined in js/src/FuseError.ts:53

Properties

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

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

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

getCause

getCause(): TFuseErrorCause
Returns TFuseErrorCause
The underlying cause of the error, if known. May be null.
- Defined in js/src/FuseError.ts:86

getCode

getCode(): number
Returns number
The error code
- Defined in js/src/FuseError.ts:79

getDomain

getDomain(): string
Returns string
The error domain, usually representing a library, class, or plugin.
- Defined in js/src/FuseError.ts:72

getMessage

getMessage(): string
Returns string
The error message
- Defined in js/src/FuseError.ts:65

serialize

serialize(): TFuseSerializable
Returns TFuseSerializable
A serialized object representing an error.
Implementation of ISerializable.serialize
- Defined in js/src/FuseError.ts:93

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in js/src/FuseError.ts:158

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`fromSerialized

fromSerialized(error: TFuseSerializable): FuseError
Deserializes and creates a new FuseError instance
Parameters
- error: TFuseSerializable
  The serialized error object
Returns FuseError
A FuseError instance
- Defined in js/src/FuseError.ts:154

`Static`wrap

wrap(error: unknown): FuseError
Wraps the given object into a FuseError object. Accepts several different formats, which influences the behaviour of this method.

If the input is a string, a FuseError object is created with the string as the error message of an unknown domain.

If the input is a FuseError, then this method does nothing but passes through the FuseError. The returned FuseError is the input FuseError, a copy is not made.

If the input is an Error, then a FuseError is created using the name as the domain, and it's message as the error message. The error object is also used as the FuseError's cause parameter.

If the input is of the shape of IFuseErrorSerialized, then the object is deserialized into a FuseError instance.

If any other type of object is given, an console error message will be printed and a "FuseError" domain error will be returned stating the error is not wrappable.
Parameters
- error: unknown
  A value that can represent an error
Returns FuseError
A FuseError instance
- Defined in js/src/FuseError.ts:126