From 1ac77ef4e51a369fd9d2e6ac309ec80c02bca5ed Mon Sep 17 00:00:00 2001 From: Tiago Rodrigues Date: Tue, 5 Apr 2016 17:15:18 +0200 Subject: [PATCH] docs: Document errors property on getEntries response Fixes #69 --- lib/entities/entry.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/entities/entry.js b/lib/entities/entry.js index b9c931c94..37e33b3e8 100644 --- a/lib/entities/entry.js +++ b/lib/entities/entry.js @@ -30,6 +30,7 @@ export function wrapEntry (data) { * @prop {number} skip * @prop {number} limit * @prop {Array} items + * @prop {Array=} errors - Array of errors that might occur when retrieving entries. * @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object * @prop {function(?function=, space=): Object} stringifySafe(replacer,space) - Stringifies the entry collection, accounting for circular references. Circular references will be replaced with just a Link object, with a circular property set to true. See MDN and json-stringify-safe for more details on the arguments this method can take. */