Interface IErrorDefinition<TData>

interface IErrorDefinition<TData> {
    dataSchema?: IValidationSchema<TData>;
    format?: ((data: TData) => string);
    id: string;
    meta?: IErrorMeta;
    parse?: ((data: string) => TData);
    serialize?: ((data: TData) => string);
}

Type Parameters

TData extends DefaultErrorType = DefaultErrorType

Hierarchy (view full)

IErrorDefinition
- IErrorDefinitionFinal

Index

Properties

dataSchema? format? id meta? parse? serialize?

Properties

`Optional`dataSchema

dataSchema?: IValidationSchema<TData>

Validate error data on throw(). If provided, data is parsed first.

`Optional`format

format?: ((data: TData) => string)

id

id: string

`Optional`meta

meta?: IErrorMeta

`Optional`parse

parse?: ((data: string) => TData)

`Optional`serialize

serialize?: ((data: TData) => string)