Interface DataDocument<PrimaryType>

interface DataDocument<PrimaryType> {
    data: PrimaryData<PrimaryType>;
    included?: default<Dictionary<any>>[];
    jsonapi?: JSONAPIObject;
    links?: Dictionary<nullish | default> | PaginationOf<default>;
    meta?: default;
}

Type Parameters

PrimaryType extends Dictionary<any>

Hierarchy

Partial<MetaDocument>
- DataDocument

Index

Properties

data included? jsonapi? links? meta?

Properties

data

data: PrimaryData<PrimaryType>

`Optional` included

included?: default<Dictionary<any>>[]

`Optional` jsonapi

jsonapi?: JSONAPIObject

`Optional` links

links?: Dictionary<nullish | default> | PaginationOf<default>

`Optional` meta

meta?: default

Generated using TypeDoc