TypeScript API / laikacms/json-api / decodeJsonApiResponse

Variable: decodeJsonApiResponse

const decodeJsonApiResponse: (input, options?) => object;

Parameters

Parameter	Type
input	unknown
options?	ParseOptions

Returns

object

data

readonly data: object = JsonApiResourceSchema;

data.attributes

readonly attributes: object;

Index Signature

[key: string]: any

data.id

readonly id: string = S.String;

data.links?

readonly optional links?: object;

Resource-level links per JSON:API spec — at minimum self, optionally related. Lets a client navigate from a collection item to its canonical detail URL without reconstructing the route table.

Index Signature

[key: string]: string

data.meta?

readonly optional meta?: object;

Per JSON:API spec, resource-level meta is the right home for protocol / backend-specific information that isn't part of the entity's primary attributes — e.g. a storage object's extension + revisionId.

Index Signature

[key: string]: any

data.relationships?

readonly optional relationships?: object;

Index Signature

[key: string]: any

data.type

readonly type: string = S.String;

links?

readonly optional links?: object;

links.first?

readonly optional first?: string;

links.last?

readonly optional last?: string;

links.next?

readonly optional next?: string;

links.prev?

readonly optional prev?: string;

links.self?

readonly optional self?: string;

meta?

readonly optional meta?: object;

Index Signature

[key: string]: any