@revideo/core / utils / DetailedError

Class: DetailedError

Defined in: utils/DetailedError.ts:8

Extends

Error

Extended by

ExperimentalError

Constructors

Constructor

new DetailedError(message, remarks?): DetailedError

Defined in: utils/DetailedError.ts:26

Parameters

message

string

remarks?

string

Returns

DetailedError

Overrides

Error.constructor

Constructor

new DetailedError(props): DetailedError

Defined in: utils/DetailedError.ts:27

Parameters

props

DetailedErrorProps

Returns

DetailedError

Overrides

Error.constructor

Properties

durationMs?

readonly optional durationMs?: number

Defined in: utils/DetailedError.ts:20

An optional duration in milliseconds.

Remarks

Can be used to display any duration related to the log. The value is always visible next to the message.

inspect?

readonly optional inspect?: string

Defined in: utils/DetailedError.ts:24

An optional key used to inspect a related object.

Remarks

This will be used together with the scenes.Inspectable interface to display additional information about the inspected object. When specified, the log will have an “inspect” button that will open the “Properties” tab and select the inspected object.

object?

readonly optional object?: any

Defined in: utils/DetailedError.ts:16

An object that will be serialized as JSON and displayed under the message.

Remarks

Visible only when the log is expanded.

remarks?

readonly optional remarks?: string

Defined in: utils/DetailedError.ts:12

The main message of the log.

Remarks

Always visible.