Skip to main content

Type Alias: ExpectedErrorOptions<TCode, TValues>

ExpectedErrorOptions<TCode, TValues> = object

Defined in: index.ts:32

Type Parameters​

Type ParameterDefault type
TCode extends string | undefinedstring | undefined
TValues extends ExpectedErrorValues | undefinedExpectedErrorValues | undefined

Properties​

cause?​

optional cause?: unknown

Defined in: index.ts:50


code?​

optional code?: TCode

Defined in: index.ts:41

Stable identifier clients branch on. Never rename one once published — change the copy instead.


messageRef?​

optional messageRef?: MessageRef

Defined in: index.ts:49

Localized message a boundary renders in the request locale.


values?​

optional values?: TValues

Defined in: index.ts:47

The data the message is about — a limit, an id, the fields that failed — kept apart from any sentence, so the code that owns the copy builds the messageRef from code and values in the reader's locale.