Interface JsonApiDocument

The JSON:API document shape for use by more specific types.

interface JsonApiDocument {
    data?: Arrayable<Data>;
    included?: Data[];
    jsonapi?: {
        ext?: Record<string, unknown>;
        meta?: Meta;
        profile?: string;
        version?: string;
    };
    links?: ApiLinks;
    meta?: Meta;
}

Properties

data? included? jsonapi? links? meta?

Properties

Optionaldata

data?: Arrayable<Data>

Optionalincluded

included?: Data[]

Optionaljsonapi

jsonapi?: {
    ext?: Record<string, unknown>;
    meta?: Meta;
    profile?: string;
    version?: string;
}

Optionallinks

links?: ApiLinks

Optionalmeta

meta?: Meta

Settings

Member Visibility

On This Page

Properties