Skip to content

Commit 0ec6a43

Browse files
committed
docs: Document includes property on getEntries response
Fixes #69
1 parent 33a419b commit 0ec6a43

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
@@ -31,6 +31,7 @@ export function wrapEntry (data) {
3131
* @prop {number} limit
3232
* @prop {Array<Entities.Entry>} items
3333
* @prop {Array<Object>=} errors - Array of errors that might occur when retrieving entries.
34+
* @prop {Object<Array>=} includes - Object with arrays of includes for Entries and Assets. This will be present if resolveLinks is on, and any linked entries or assets exist. Those links will be resolved in the Entries present in the items array, but they are also present here in raw form.
3435
* @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object
3536
* @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.
3637
*/

0 commit comments

Comments
 (0)