Skip to content

Commit 1ac77ef

Browse files
committed
docs: Document errors property on getEntries response
Fixes #69
1 parent d6bef03 commit 1ac77ef

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

lib/entities/entry.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export function wrapEntry (data) {
3030
* @prop {number} skip
3131
* @prop {number} limit
3232
* @prop {Array<Entities.Entry>} items
33+
* @prop {Array<Object>=} errors - Array of errors that might occur when retrieving entries.
3334
* @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object
3435
* @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 <code>circular</code> property set to <code>true</code>. See <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">MDN</a> and <a href="https://www.npmjs.com/package/json-stringify-safe">json-stringify-safe</a> for more details on the arguments this method can take.
3536
*/

0 commit comments

Comments
 (0)