JsonListResponse

Type parameters

▪ Raw: RawListResponse‹any, any›

▪ I: IncludedGroups

Hierarchy

• JsonListResponse

Index

Constructors

• constructor

Properties

• limit

• offset

• raw

• response

Accessors

• elements

• included

• meta

Constructors

constructor

+ new JsonListResponse(raw: Raw, limit: number, offset: number | undefined, rawIncludedGroups: I, response: HttpResponse‹Raw›): JsonListResponse

Defined in jsonApi.getList.ts:8

Parameters:

Name	Type
raw	Raw
limit	number
offset	number | undefined
rawIncludedGroups	I
response	HttpResponse‹Raw›

Returns: JsonListResponse

Properties

limit

• limit: number

Defined in jsonApi.getList.ts:12

offset

• offset: number | undefined

Defined in jsonApi.getList.ts:13

raw

• raw: Raw

Defined in jsonApi.getList.ts:11

response

• response: HttpResponse‹Raw›

Defined in jsonApi.getList.ts:15

Accessors

elements

• get elements(): MergedData‹Raw["data"]›

Defined in jsonApi.getList.ts:19

Returns: MergedData‹Raw["data"]›

included

• get included(): object

Defined in jsonApi.getList.ts:27

Returns: object

meta

• get meta(): Raw["meta"]

Defined in jsonApi.getList.ts:23

Returns: Raw["meta"]