Skip to content

Commit e1642fb

Browse files
committed
Update API docs
1 parent 8677368 commit e1642fb

1 file changed

Lines changed: 0 additions & 40 deletions

File tree

API-INTERNAL.md

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -79,17 +79,6 @@ run out of storage the least recently accessed key can be removed.</p>
7979
<dt><a href="#getCollectionDataAndSendAsObject">getCollectionDataAndSendAsObject()</a></dt>
8080
<dd><p>Gets the data for a given an array of matching keys, combines them into an object, and sends the result back to the subscriber.</p>
8181
</dd>
82-
<dt><a href="#prepareSubscriberUpdate">prepareSubscriberUpdate(callback)</a></dt>
83-
<dd><p>Delays promise resolution until the next macrotask to prevent race condition if the key subscription is in progress.</p>
84-
</dd>
85-
<dt><a href="#scheduleSubscriberUpdate">scheduleSubscriberUpdate()</a></dt>
86-
<dd><p>Schedules an update that will be appended to the macro task queue (so it doesn&#39;t update the subscribers immediately).</p>
87-
</dd>
88-
<dt><a href="#scheduleNotifyCollectionSubscribers">scheduleNotifyCollectionSubscribers()</a></dt>
89-
<dd><p>This method is similar to scheduleSubscriberUpdate but it is built for working specifically with collections
90-
so that keysChanged() is triggered for the collection and not keyChanged(). If this was not done, then the
91-
subscriber callbacks receive the data in a different format than they normally expect and it breaks code.</p>
92-
</dd>
9382
<dt><a href="#remove">remove()</a></dt>
9483
<dd><p>Remove a key from Onyx and update the subscribers</p>
9584
</dd>
@@ -350,35 +339,6 @@ run out of storage the least recently accessed key can be removed.
350339
## getCollectionDataAndSendAsObject()
351340
Gets the data for a given an array of matching keys, combines them into an object, and sends the result back to the subscriber.
352341

353-
**Kind**: global function
354-
<a name="prepareSubscriberUpdate"></a>
355-
356-
## prepareSubscriberUpdate(callback)
357-
Delays promise resolution until the next macrotask to prevent race condition if the key subscription is in progress.
358-
359-
**Kind**: global function
360-
361-
| Param | Description |
362-
| --- | --- |
363-
| callback | The keyChanged/keysChanged callback |
364-
365-
<a name="scheduleSubscriberUpdate"></a>
366-
367-
## scheduleSubscriberUpdate()
368-
Schedules an update that will be appended to the macro task queue (so it doesn't update the subscribers immediately).
369-
370-
**Kind**: global function
371-
**Example**
372-
```js
373-
scheduleSubscriberUpdate(key, value, subscriber => subscriber.initWithStoredValues === false)
374-
```
375-
<a name="scheduleNotifyCollectionSubscribers"></a>
376-
377-
## scheduleNotifyCollectionSubscribers()
378-
This method is similar to scheduleSubscriberUpdate but it is built for working specifically with collections
379-
so that keysChanged() is triggered for the collection and not keyChanged(). If this was not done, then the
380-
subscriber callbacks receive the data in a different format than they normally expect and it breaks code.
381-
382342
**Kind**: global function
383343
<a name="remove"></a>
384344

0 commit comments

Comments
 (0)