TypeScript API / laikacms/json-api / decodeJsonApiCollectionResponse

Variable: decodeJsonApiCollectionResponse

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

Parameters

Parameter	Type
input	unknown
options?	ParseOptions

Returns

object

data

readonly data: readonly object[];

included?

readonly optional included?: readonly object[];

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;

meta.page?

readonly optional page?: object;

meta.page.estimatedTotal?

readonly optional estimatedTotal?: number;

meta.page.total?

readonly optional total?: number;

meta.warnings?

readonly optional warnings?: readonly object[];

Per-item recoverable errors emitted while assembling this response. Surfaces LaikaStream recoverableErrors (per-key delete failures, unreadable subfolders, corrupt rows, …) without aborting the response. Same shape as a top-level JSON:API error object.