Hierarchy

• Options

Index

Properties

• pagination

• sort

Properties

Optional pagination

• pagination? : undefined | false | true

Defined in jsonApi.builder.ts:11

Optional sort

• sort? : undefined | false | true

Defined in jsonApi.builder.ts:10

Included groups

Included groups allow you to extract stuff from 'included' JSON API field basing on specified name-type pairs, and add proper types to it.

Type parameters

▪ D: AnyData

Hierarchy

• IncludedGroup

Index

Properties

• __d

• type

Properties

__d

• __d: D

Defined in jsonApi.interface.ts:103

type

• type: string

Defined in jsonApi.interface.ts:102

Hierarchy

• Attributes

Indexable

• [ x: string]: any

Hierarchy

• ListMetaData

Index

Properties

Properties

totalResourceCount

• totalResourceCount: number

Defined in

Type parameters

▪ Attrs: Attributes

▪ Rels: OptionalRels

Hierarchy

• Data

Index

Properties

• attributes

• id

• links

• relationships

• type

Properties

attributes

• attributes: Attrs

Defined in jsonApi.interface.ts:39

id

• id: string

Defined in jsonApi.interface.ts:37

links

• links: object

Defined in jsonApi.interface.ts:41

Type declaration:

• self: string

relationships

• relationships: Rels

Defined in jsonApi.interface.ts:40

type

• type: string

Defined in jsonApi.interface.ts:38

Type parameters

▪ D: AnyData

▪ M: ListMetaData

Hierarchy

• RawListResponse

Index

Properties

• data

• included

• links

• meta

Properties

data

• data: D[]

Defined in jsonApi.interface.ts:126

Optional included

• included? : IncludedRelationships

Defined in jsonApi.interface.ts:133

links

• links: object

Defined in jsonApi.interface.ts:127

Type declaration:

• first: string

• last: string

• next? : undefined | string

• prev? : undefined | string

meta

• meta: M

Defined in jsonApi.interface.ts:134

Type parameters

▪ D: AnyData

▪ M: object

Hierarchy

• RawResponse

Index

Properties

• data

• included

• meta

Properties

data

• data: D

Defined in jsonApi.interface.ts:120

Optional included

• included? : IncludedRelationships

Defined in jsonApi.interface.ts:122

Optional meta

• meta? : M

Defined in jsonApi.interface.ts:121