Interface ReportedErrorOptions

Options accepted by AbstractReportedError.

interface ReportedErrorOptions {
    message?: string;
    messageParams?: unknown;
    parentError?: Error;
    payload?: Record<string, unknown>;
    translateFn?: TranslateFn;
    userMessage?: string;
    userMessageParams?: unknown;
}

Hierarchy (View Summary)

Properties

message? messageParams? parentError? payload? translateFn? userMessage? userMessageParams?

Properties

Optionalmessage

message?: string

Message template (sprintf-compatible) used for the error.

OptionalmessageParams

messageParams?: unknown

Parameters that will be interpolated into the formatted message.

OptionalparentError

parentError?: Error

Underlying error that triggered the current failure.

Optionalpayload

payload?: Record<string, unknown>

Additional structured data attached to the error instance.

OptionaltranslateFn

translateFn?: TranslateFn

Formatter used to render the localized user message.

OptionaluserMessage

userMessage?: string

i18n key or literal string visible to end users.

OptionaluserMessageParams

userMessageParams?: unknown

Parameters interpolated into the localized user message.

Settings

Member Visibility

On This Page

Properties