TypeScript API / laikacms/json-api / decodeJsonApiResource

Variable: decodeJsonApiResource

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

Parameters

Parameter	Type
input	unknown
options?	ParseOptions

Returns

attributes

readonly attributes: object;

Index Signature

[key: string]: any

id

readonly id: string = S.String;

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

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

relationships?

readonly optional relationships?: object;

Index Signature

[key: string]: any

type

readonly type: string = S.String;