Skip to content

TypeScript API / contentia/json-api / decodeJsonApiCollectionResponse

Variable: decodeJsonApiCollectionResponse ​

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

Parameters ​

ParameterType
inputunknown
options?ParseOptions

Returns ​

object

data ​

ts
readonly data: readonly object[];

included? ​

ts
readonly included?: readonly object[];
ts
readonly links?: object;
ts
readonly first?: string;
ts
readonly last?: string;
ts
readonly next?: string;
ts
readonly prev?: string;
ts
readonly self?: string;

meta? ​

ts
readonly meta?: object;

meta.page? ​

ts
readonly page?: object;

meta.page.estimatedTotal? ​

ts
readonly estimatedTotal?: number;

meta.page.total? ​

ts
readonly total?: number;

meta.warnings? ​

ts
readonly warnings?: readonly object[];

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