Interface ErrorSerializerOptions<T>

interface ErrorSerializerOptions<T> {
    attributes: Partial<ErrorAttributeOption<T>>;
    linkers: {
        about?: Linker<[JapiError]>;
    };
    metaizers: {
        document?: Metaizer<[JapiError[]]>;
        error?: Metaizer<[JapiError]>;
        jsonapi?: Metaizer<[]>;
    };
    version: null | string;
}

Type Parameters

Properties

attributes linkers metaizers version

Properties

attributes

attributes: Partial<ErrorAttributeOption<T>>

An object of attribute names to use in place of the default ones.

linkers

linkers: {
    about?: Linker<[JapiError]>;
}

A set of options for constructing top-level links.

Type declaration

metaizers

metaizers: {
    document?: Metaizer<[JapiError[]]>;
    error?: Metaizer<[JapiError]>;
    jsonapi?: Metaizer<[]>;
}

A dictionary of Metaizers to use in different locations of the document.

Type declaration

version

version: null | string

The highest JSON API version supported.

Default Value

1.0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc