Skip to content

Commit dfbe400

Browse files
committed
Update docs
1 parent 9db1607 commit dfbe400

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

API.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Subscribes a react component's state directly to a store key
7676
| [mapping.withOnyxInstance] | <code>Object</code> | whose setState() method will be called with any changed data This is used by React components to connect to Onyx |
7777
| [mapping.callback] | <code>function</code> | a method that will be called with changed data This is used by any non-React code to connect to Onyx |
7878
| [mapping.initWithStoredValues] | <code>Boolean</code> | If set to false, then no data will be prefilled into the component |
79+
| [mapping.waitForCollectionCallback] | <code>Boolean</code> | If set to true, it will return the entire collection to the callback as a single object |
7980

8081
**Example**
8182
```js

lib/Onyx.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ function sendDataToConnection(config, val, key) {
412412
* This is used by any non-React code to connect to Onyx
413413
* @param {Boolean} [mapping.initWithStoredValues] If set to false, then no data will be prefilled into the
414414
* component
415-
* @param {Boolean} [mapping.waitForCollectionCallback] If set to true, it will trigger the callback once and return all data as a single object
415+
* @param {Boolean} [mapping.waitForCollectionCallback] If set to true, it will return the entire collection to the callback as a single object
416416
* @returns {Number} an ID to use when calling disconnect
417417
*/
418418
function connect(mapping) {

0 commit comments

Comments
 (0)