react-native-onyx 2.0.26 → 2.0.28

package/API.md

@@ -1,70 +1,26 @@
-<!---These docs were automatically generated. Do not edit them directly run `npm run build-docs` script-->
+<!---These docs were automatically generated. Do not edit them directly run `npm run build:docs` script-->
 
 # API Reference
 
 ## Functions
 
 <dl>
-<dt><a href="#sendActionToDevTools">sendActionToDevTools(method, key, value, mergedValue)</a></dt>
-<dd><p>Sends an action to DevTools extension</p>
-</dd>
-<dt><a href="#maybeFlushBatchUpdates">maybeFlushBatchUpdates()</a> ⇒ <code>Promise</code></dt>
-<dd><p>We are batching together onyx updates. This helps with use cases where we schedule onyx updates after each other.
-This happens for example in the Onyx.update function, where we process API responses that might contain a lot of
-update operations. Instead of calling the subscribers for each update operation, we batch them together which will
-cause react to schedule the updates at once instead of after each other. This is mainly a performance optimization.</p>
-</dd>
-<dt><a href="#getSubsetOfData">getSubsetOfData(sourceData, selector, [withOnyxInstanceState])</a> ⇒ <code>Mixed</code></dt>
-<dd><p>Uses a selector function to return a simplified version of sourceData</p>
-</dd>
-<dt><a href="#reduceCollectionWithSelector">reduceCollectionWithSelector(collection, selector, [withOnyxInstanceState])</a> ⇒ <code>Object</code></dt>
-<dd><p>Takes a collection of items (eg. {testKey_1:{a:&#39;a&#39;}, testKey_2:{b:&#39;b&#39;}})
-and runs it through a reducer function to return a subset of the data according to a selector.
-The resulting collection will only contain items that are returned by the selector.</p>
-</dd>
-<dt><a href="#isCollectionKey">isCollectionKey(key)</a> ⇒ <code>Boolean</code></dt>
-<dd><p>Checks to see if the a subscriber&#39;s supplied key
-is associated with a collection of keys.</p>
-</dd>
-<dt><a href="#isCollectionMemberKey">isCollectionMemberKey(collectionKey, key)</a> ⇒ <code>Boolean</code></dt>
-<dd></dd>
-<dt><a href="#splitCollectionMemberKey">splitCollectionMemberKey(key)</a> ⇒ <code>Array.&lt;String&gt;</code></dt>
-<dd><p>Splits a collection member key into the collection key part and the ID part.</p>
-</dd>
-<dt><a href="#tryGetCachedValue">tryGetCachedValue(key, mapping)</a> ⇒ <code>Mixed</code></dt>
-<dd><p>Tries to get a value from the cache. If the value is not present in cache it will return the default value or undefined.
-If the requested key is a collection, it will return an object with all the collection members.</p>
+<dt><a href="#init">init()</a></dt>
+<dd><p>Initialize the store with actions and listening for storage events</p>
 </dd>
-<dt><a href="#connect">connect(mapping)</a> ⇒ <code>Number</code></dt>
+<dt><a href="#connect">connect(mapping)</a> ⇒</dt>
 <dd><p>Subscribes a react component&#39;s state directly to a store key</p>
 </dd>
-<dt><a href="#disconnect">disconnect(connectionID, [keyToRemoveFromEvictionBlocklist])</a></dt>
+<dt><a href="#disconnect">disconnect(connectionID)</a></dt>
 <dd><p>Remove the listener for a react component</p>
 </dd>
-<dt><a href="#scheduleSubscriberUpdate">scheduleSubscriberUpdate(key, value, prevValue, [canUpdateSubscriber])</a> ⇒ <code>Promise</code></dt>
-<dd><p>Schedules an update that will be appended to the macro task queue (so it doesn&#39;t update the subscribers immediately).</p>
-</dd>
-<dt><a href="#scheduleNotifyCollectionSubscribers">scheduleNotifyCollectionSubscribers(key, value)</a> ⇒ <code>Promise</code></dt>
-<dd><p>This method is similar to notifySubscribersOnNextTick but it is built for working specifically with collections
-so that keysChanged() is triggered for the collection and not keyChanged(). If this was not done, then the
-subscriber callbacks receive the data in a different format than they normally expect and it breaks code.</p>
-</dd>
-<dt><a href="#broadcastUpdate">broadcastUpdate(key, value, hasChanged, wasRemoved)</a> ⇒ <code>Promise</code></dt>
-<dd><p>Notifys subscribers and writes current value to cache</p>
-</dd>
-<dt><a href="#hasPendingMergeForKey">hasPendingMergeForKey(key)</a> ⇒ <code>Boolean</code></dt>
-<dd></dd>
-<dt><a href="#removeNullValues">removeNullValues(key, value)</a> ⇒ <code>Mixed</code></dt>
-<dd><p>Removes a key from storage if the value is null.
-Otherwise removes all nested null values in objects and returns the object</p>
-</dd>
-<dt><a href="#set">set(key, value)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#set">set(key, value)</a></dt>
 <dd><p>Write a value to our store with the given key</p>
 </dd>
-<dt><a href="#multiSet">multiSet(data)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#multiSet">multiSet(data)</a></dt>
 <dd><p>Sets multiple keys and values</p>
 </dd>
-<dt><a href="#merge">merge(key, changes)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#merge">merge()</a></dt>
 <dd><p>Merge a new value into an existing value at a key.</p>
 <p>The types of values that can be merged are <code>Object</code> and <code>Array</code>. To set another type of value use <code>Onyx.set()</code>.
 Values of type <code>Object</code> get merged with the old value, whilst for <code>Array</code>&#39;s we simply replace the current value with the new one.</p>
@@ -72,7 +28,10 @@ Values of type <code>Object</code> get merged with the old value, whilst for <co
 applied in the order they were called. Note: <code>Onyx.set()</code> calls do not work this way so use caution when mixing
 <code>Onyx.merge()</code> and <code>Onyx.set()</code>.</p>
 </dd>
-<dt><a href="#clear">clear(keysToPreserve)</a> ⇒ <code>Promise.&lt;void&gt;</code></dt>
+<dt><a href="#mergeCollection">mergeCollection(collectionKey, collection)</a></dt>
+<dd><p>Merges a collection based on their keys</p>
+</dd>
+<dt><a href="#clear">clear(keysToPreserve)</a></dt>
 <dd><p>Clear out all the data in the store</p>
 <p>Note that calling Onyx.clear() and then Onyx.set() on a key with a default
 key state may store an unexpected value in Storage.</p>
@@ -88,136 +47,38 @@ Onyx.get(key) before calling Storage.setItem() via Onyx.set().
 Storage.setItem() from Onyx.clear() will have already finished and the merged
 value will be saved to storage after the default value.</p>
 </dd>
-<dt><a href="#mergeCollection">mergeCollection(collectionKey, collection)</a> ⇒ <code>Promise</code></dt>
-<dd><p>Merges a collection based on their keys</p>
-</dd>
-<dt><a href="#update">update(data)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#update">update(data)</a> ⇒</dt>
 <dd><p>Insert API responses and lifecycle data into Onyx</p>
 </dd>
-<dt><a href="#init">init([options])</a></dt>
-<dd><p>Initialize the store with actions and listening for storage events</p>
-</dd>
 </dl>
 
-<a name="sendActionToDevTools"></a>
-
-## sendActionToDevTools(method, key, value, mergedValue)
-Sends an action to DevTools extension
-
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| method | <code>string</code> | Onyx method from METHOD |
-| key | <code>string</code> | Onyx key that was changed |
-| value | <code>any</code> | contains the change that was made by the method |
-| mergedValue | <code>any</code> | (optional) value that was written in the storage after a merge method was executed. |
-
-<a name="maybeFlushBatchUpdates"></a>
-
-## maybeFlushBatchUpdates() ⇒ <code>Promise</code>
-We are batching together onyx updates. This helps with use cases where we schedule onyx updates after each other.
-This happens for example in the Onyx.update function, where we process API responses that might contain a lot of
-update operations. Instead of calling the subscribers for each update operation, we batch them together which will
-cause react to schedule the updates at once instead of after each other. This is mainly a performance optimization.
-
-**Kind**: global function
-<a name="getSubsetOfData"></a>
-
-## getSubsetOfData(sourceData, selector, [withOnyxInstanceState]) ⇒ <code>Mixed</code>
-Uses a selector function to return a simplified version of sourceData
-
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| sourceData | <code>Mixed</code> |  |
-| selector | <code>function</code> | Function that takes sourceData and returns a simplified version of it |
-| [withOnyxInstanceState] | <code>Object</code> |  |
-
-<a name="reduceCollectionWithSelector"></a>
-
-## reduceCollectionWithSelector(collection, selector, [withOnyxInstanceState]) ⇒ <code>Object</code>
-Takes a collection of items (eg. {testKey_1:{a:'a'}, testKey_2:{b:'b'}})
-and runs it through a reducer function to return a subset of the data according to a selector.
-The resulting collection will only contain items that are returned by the selector.
-
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| collection | <code>Object</code> |  |
-| selector | <code>String</code> \| <code>function</code> | (see method docs for getSubsetOfData() for full details) |
-| [withOnyxInstanceState] | <code>Object</code> |  |
-
-<a name="isCollectionKey"></a>
-
-## isCollectionKey(key) ⇒ <code>Boolean</code>
-Checks to see if the a subscriber's supplied key
-is associated with a collection of keys.
-
-**Kind**: global function
-
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-
-<a name="isCollectionMemberKey"></a>
-
-## isCollectionMemberKey(collectionKey, key) ⇒ <code>Boolean</code>
-**Kind**: global function
-
-| Param | Type |
-| --- | --- |
-| collectionKey | <code>String</code> |
-| key | <code>String</code> |
-
-<a name="splitCollectionMemberKey"></a>
-
-## splitCollectionMemberKey(key) ⇒ <code>Array.&lt;String&gt;</code>
-Splits a collection member key into the collection key part and the ID part.
-
-**Kind**: global function
-**Returns**: <code>Array.&lt;String&gt;</code> - A tuple where the first element is the collection part and the second element is the ID part.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| key | <code>String</code> | The collection member key to split. |
-
-<a name="tryGetCachedValue"></a>
-
-## tryGetCachedValue(key, mapping) ⇒ <code>Mixed</code>
-Tries to get a value from the cache. If the value is not present in cache it will return the default value or undefined.
-If the requested key is a collection, it will return an object with all the collection members.
-
-**Kind**: global function
+<a name="init"></a>
 
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-| mapping | <code>Object</code> |
+## init()
+Initialize the store with actions and listening for storage events
 
+**Kind**: global function  
 <a name="connect"></a>
 
-## connect(mapping) ⇒ <code>Number</code>
+## connect(mapping) ⇒
 Subscribes a react component's state directly to a store key
 
-**Kind**: global function
-**Returns**: <code>Number</code> - an ID to use when calling disconnect
-
-| Param | Type | Description |
-| --- | --- | --- |
-| mapping | <code>Object</code> | the mapping information to connect Onyx to the components state |
-| mapping.key | <code>String</code> | ONYXKEY to subscribe to |
-| [mapping.statePropertyName] | <code>String</code> | the name of the property in the state to connect the data to |
-| [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 |
-| [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 |
-| [mapping.initWithStoredValues] | <code>Boolean</code> | If set to false, then no data will be prefilled into the  component |
-| [mapping.waitForCollectionCallback] | <code>Boolean</code> | If set to true, it will return the entire collection to the callback as a single object |
-| [mapping.selector] | <code>function</code> | THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data.       The sourceData and withOnyx state are passed to the selector and should return the simplified data. Using this setting on `withOnyx` can have very positive       performance benefits because the component will only re-render when the subset of data changes. Otherwise, any change of data on any property would normally       cause the component to re-render (and that can be expensive from a performance standpoint). |
-| [mapping.initialValue] | <code>String</code> \| <code>Number</code> \| <code>Boolean</code> \| <code>Object</code> | THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be passed to the component so that something can be rendered while data is being fetched from the DB. Note that it will not cause the component to have the loading prop set to true. | |
-
-**Example**
+**Kind**: global function  
+**Returns**: an ID to use when calling disconnect  
+
+| Param | Description |
+| --- | --- |
+| mapping | the mapping information to connect Onyx to the components state |
+| mapping.key | ONYXKEY to subscribe to |
+| [mapping.statePropertyName] | the name of the property in the state to connect the data to |
+| [mapping.withOnyxInstance] | whose setState() method will be called with any changed data      This is used by React components to connect to Onyx |
+| [mapping.callback] | a method that will be called with changed data      This is used by any non-React code to connect to Onyx |
+| [mapping.initWithStoredValues] | If set to false, then no data will be prefilled into the  component |
+| [mapping.waitForCollectionCallback] | If set to true, it will return the entire collection to the callback as a single object |
+| [mapping.selector] | THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data.       The sourceData and withOnyx state are passed to the selector and should return the simplified data. Using this setting on `withOnyx` can have very positive       performance benefits because the component will only re-render when the subset of data changes. Otherwise, any change of data on any property would normally       cause the component to re-render (and that can be expensive from a performance standpoint). |
+| [mapping.initialValue] | THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be passed to the component so that something can be rendered while data is being fetched from the DB. Note that it will not cause the component to have the loading prop set to true. |
+
+**Example**  
 ```js
 const connectionID = Onyx.connect({
     key: ONYXKEYS.SESSION,
@@ -226,119 +87,49 @@ const connectionID = Onyx.connect({
 ```
 <a name="disconnect"></a>
 
-## disconnect(connectionID, [keyToRemoveFromEvictionBlocklist])
+## disconnect(connectionID)
 Remove the listener for a react component
 
-**Kind**: global function
+**Kind**: global function  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| connectionID | <code>Number</code> | unique id returned by call to Onyx.connect() |
-| [keyToRemoveFromEvictionBlocklist] | <code>String</code> |  |
+| Param | Description |
+| --- | --- |
+| connectionID | unique id returned by call to Onyx.connect() |
 
-**Example**
+**Example**  
 ```js
 Onyx.disconnect(connectionID);
 ```
-<a name="scheduleSubscriberUpdate"></a>
-
-## scheduleSubscriberUpdate(key, value, prevValue, [canUpdateSubscriber]) ⇒ <code>Promise</code>
-Schedules an update that will be appended to the macro task queue (so it doesn't update the subscribers immediately).
-
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| key | <code>String</code> |  |
-| value | <code>\*</code> |  |
-| prevValue | <code>\*</code> |  |
-| [canUpdateSubscriber] | <code>function</code> | only subscribers that pass this truth test will be updated |
-
-**Example**
-```js
-scheduleSubscriberUpdate(key, value, subscriber => subscriber.initWithStoredValues === false)
-```
-<a name="scheduleNotifyCollectionSubscribers"></a>
-
-## scheduleNotifyCollectionSubscribers(key, value) ⇒ <code>Promise</code>
-This method is similar to notifySubscribersOnNextTick but it is built for working specifically with collections
-so that keysChanged() is triggered for the collection and not keyChanged(). If this was not done, then the
-subscriber callbacks receive the data in a different format than they normally expect and it breaks code.
-
-**Kind**: global function
-
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-| value | <code>\*</code> |
-
-<a name="broadcastUpdate"></a>
-
-## broadcastUpdate(key, value, hasChanged, wasRemoved) ⇒ <code>Promise</code>
-Notifys subscribers and writes current value to cache
-
-**Kind**: global function
-
-| Param | Type | Default |
-| --- | --- | --- |
-| key | <code>String</code> |  |
-| value | <code>\*</code> |  |
-| hasChanged | <code>Boolean</code> |  |
-| wasRemoved | <code>Boolean</code> | <code>false</code> |
-
-<a name="hasPendingMergeForKey"></a>
-
-## hasPendingMergeForKey(key) ⇒ <code>Boolean</code>
-**Kind**: global function
-
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-
-<a name="removeNullValues"></a>
-
-## removeNullValues(key, value) ⇒ <code>Mixed</code>
-Removes a key from storage if the value is null.
-Otherwise removes all nested null values in objects and returns the object
-
-**Kind**: global function
-**Returns**: <code>Mixed</code> - The value without null values and a boolean "wasRemoved", which indicates if the key got removed completely
-
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-| value | <code>Mixed</code> |
-
 <a name="set"></a>
 
-## set(key, value) ⇒ <code>Promise</code>
+## set(key, value)
 Write a value to our store with the given key
 
-**Kind**: global function
+**Kind**: global function  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| key | <code>String</code> | ONYXKEY to set |
-| value | <code>\*</code> | value to store |
+| Param | Description |
+| --- | --- |
+| key | ONYXKEY to set |
+| value | value to store |
 
 <a name="multiSet"></a>
 
-## multiSet(data) ⇒ <code>Promise</code>
+## multiSet(data)
 Sets multiple keys and values
 
-**Kind**: global function
+**Kind**: global function  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| data | <code>Object</code> | object keyed by ONYXKEYS and the values to set |
+| Param | Description |
+| --- | --- |
+| data | object keyed by ONYXKEYS and the values to set |
 
-**Example**
+**Example**  
 ```js
 Onyx.multiSet({'key1': 'a', 'key2': 'b'});
 ```
 <a name="merge"></a>
 
-## merge(key, changes) ⇒ <code>Promise</code>
+## merge()
 Merge a new value into an existing value at a key.
 
 The types of values that can be merged are `Object` and `Array`. To set another type of value use `Onyx.set()`.
@@ -348,23 +139,36 @@ Calls to `Onyx.merge()` are batched so that any calls performed in a single tick
 applied in the order they were called. Note: `Onyx.set()` calls do not work this way so use caution when mixing
 `Onyx.merge()` and `Onyx.set()`.
 
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| key | <code>String</code> | ONYXKEYS key |
-| changes | <code>Object</code> \| <code>Array</code> | Object or Array value to merge |
-
-**Example**
+**Kind**: global function  
+**Example**  
 ```js
 Onyx.merge(ONYXKEYS.EMPLOYEE_LIST, ['Joe']); // -> ['Joe']
 Onyx.merge(ONYXKEYS.EMPLOYEE_LIST, ['Jack']); // -> ['Joe', 'Jack']
 Onyx.merge(ONYXKEYS.POLICY, {id: 1}); // -> {id: 1}
 Onyx.merge(ONYXKEYS.POLICY, {name: 'My Workspace'}); // -> {id: 1, name: 'My Workspace'}
 ```
+<a name="mergeCollection"></a>
+
+## mergeCollection(collectionKey, collection)
+Merges a collection based on their keys
+
+**Kind**: global function  
+
+| Param | Description |
+| --- | --- |
+| collectionKey | e.g. `ONYXKEYS.COLLECTION.REPORT` |
+| collection | Object collection keyed by individual collection member keys and values |
+
+**Example**  
+```js
+Onyx.mergeCollection(ONYXKEYS.COLLECTION.REPORT, {
+    [`${ONYXKEYS.COLLECTION.REPORT}1`]: report1,
+    [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
+});
+```
 <a name="clear"></a>
 
-## clear(keysToPreserve) ⇒ <code>Promise.&lt;void&gt;</code>
+## clear(keysToPreserve)
 Clear out all the data in the store
 
 Note that calling Onyx.clear() and then Onyx.set() on a key with a default
@@ -383,67 +187,21 @@ Onyx.get(key) before calling Storage.setItem() via Onyx.set().
 Storage.setItem() from Onyx.clear() will have already finished and the merged
 value will be saved to storage after the default value.
 
-**Kind**: global function
+**Kind**: global function  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| keysToPreserve | <code>Array</code> | is a list of ONYXKEYS that should not be cleared with the rest of the data |
-
-<a name="mergeCollection"></a>
-
-## mergeCollection(collectionKey, collection) ⇒ <code>Promise</code>
-Merges a collection based on their keys
-
-**Kind**: global function
-
-| Param | Type | Description |
-| --- | --- | --- |
-| collectionKey | <code>String</code> | e.g. `ONYXKEYS.COLLECTION.REPORT` |
-| collection | <code>Object</code> | Object collection keyed by individual collection member keys and values |
+| Param | Description |
+| --- | --- |
+| keysToPreserve | is a list of ONYXKEYS that should not be cleared with the rest of the data |
 
-**Example**
-```js
-Onyx.mergeCollection(ONYXKEYS.COLLECTION.REPORT, {
-    [`${ONYXKEYS.COLLECTION.REPORT}1`]: report1,
-    [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
-});
-```
 <a name="update"></a>
 
-## update(data) ⇒ <code>Promise</code>
+## update(data) ⇒
 Insert API responses and lifecycle data into Onyx
 
-**Kind**: global function
-**Returns**: <code>Promise</code> - resolves when all operations are complete
-
-| Param | Type | Description |
-| --- | --- | --- |
-| data | <code>Array</code> | An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *} |
-
-<a name="init"></a>
-
-## init([options])
-Initialize the store with actions and listening for storage events
-
-**Kind**: global function
+**Kind**: global function  
+**Returns**: resolves when all operations are complete  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [options] | <code>Object</code> | <code>{}</code> | config object |
-| [options.keys] | <code>Object</code> | <code>{}</code> | `ONYXKEYS` constants object |
-| [options.initialKeyStates] | <code>Object</code> | <code>{}</code> | initial data to set when `init()` and `clear()` is called |
-| [options.safeEvictionKeys] | <code>Array.&lt;String&gt;</code> | <code>[]</code> | This is an array of keys (individual or collection patterns) that when provided to Onyx are flagged as "safe" for removal. Any components subscribing to these keys must also implement a canEvict option. See the README for more info. |
-| [options.maxCachedKeysCount] | <code>Number</code> | <code>55</code> | Sets how many recent keys should we try to keep in cache Setting this to 0 would practically mean no cache We try to free cache when we connect to a safe eviction key |
-| [options.captureMetrics] | <code>Boolean</code> |  | Enables Onyx benchmarking and exposes the get/print/reset functions |
-| [options.shouldSyncMultipleInstances] | <code>Boolean</code> |  | Auto synchronize storage events between multiple instances of Onyx running in different tabs/windows. Defaults to true for platforms that support local storage (web/desktop) |
-| [options.debugSetState] | <code>Boolean</code> |  | Enables debugging setState() calls to connected components. |
+| Param | Description |
+| --- | --- |
+| data | An array of objects with update expressions |
 
-**Example**
-```js
-Onyx.init({
-    keys: ONYXKEYS,
-    initialKeyStates: {
-        [ONYXKEYS.SESSION]: {loading: false},
-    },
-});
-```

package/dist/DevTools.d.ts

@@ -30,7 +30,7 @@ declare class DevTools {
      * @param payload - data written to the storage
      * @param stateChanges - partial state that got updated after the changes
      */
-    registerAction(type: string, payload: unknown, stateChanges?: Record<string, unknown>): void;
+    registerAction(type: string, payload: unknown, stateChanges?: Record<string, unknown> | null): void;
     initState(initialState?: Record<string, unknown>): void;
     /**
      * This clears the internal state of the DevTools, preserving the keys included in `keysToPreserve`

package/dist/Onyx.d.ts

@@ -30,7 +30,7 @@ declare function init({ keys, initialKeyStates, safeEvictionKeys, maxCachedKeysC
  * Note that it will not cause the component to have the loading prop set to true.
  * @returns an ID to use when calling disconnect
  */
-declare function connect<TKey extends OnyxKey>(mapping: ConnectOptions<TKey>): number;
+declare function connect<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKey>): number;
 /**
  * Remove the listener for a react component
  * @example
@@ -45,7 +45,7 @@ declare function disconnect(connectionID: number, keyToRemoveFromEvictionBlockli
  * @param key ONYXKEY to set
  * @param value value to store
  */
-declare function set<TKey extends OnyxKey>(key: TKey, value: OnyxEntry<KeyValueMapping[TKey]>): Promise<void[]>;
+declare function set<TKey extends OnyxKey>(key: TKey, value: OnyxEntry<KeyValueMapping[TKey]>): Promise<void>;
 /**
  * Sets multiple keys and values
  *
@@ -53,7 +53,7 @@ declare function set<TKey extends OnyxKey>(key: TKey, value: OnyxEntry<KeyValueM
  *
  * @param data object keyed by ONYXKEYS and the values to set
  */
-declare function multiSet(data: Partial<NullableKeyValueMapping>): Promise<void[]>;
+declare function multiSet(data: Partial<NullableKeyValueMapping>): Promise<void>;
 /**
  * Merge a new value into an existing value at a key.
  *
@@ -70,7 +70,7 @@ declare function multiSet(data: Partial<NullableKeyValueMapping>): Promise<void[
  * Onyx.merge(ONYXKEYS.POLICY, {id: 1}); // -> {id: 1}
  * Onyx.merge(ONYXKEYS.POLICY, {name: 'My Workspace'}); // -> {id: 1, name: 'My Workspace'}
  */
-declare function merge<TKey extends OnyxKey>(key: TKey, changes: OnyxEntry<NullishDeep<KeyValueMapping[TKey]>>): Promise<void | void[]>;
+declare function merge<TKey extends OnyxKey>(key: TKey, changes: OnyxEntry<NullishDeep<KeyValueMapping[TKey]>>): Promise<void>;
 /**
  * Merges a collection based on their keys
  *
@@ -106,14 +106,14 @@ declare function mergeCollection<TKey extends CollectionKeyBase, TMap>(collectio
  *
  * @param keysToPreserve is a list of ONYXKEYS that should not be cleared with the rest of the data
  */
-declare function clear(keysToPreserve?: OnyxKey[]): Promise<void[]>;
+declare function clear(keysToPreserve?: OnyxKey[]): Promise<void>;
 /**
  * Insert API responses and lifecycle data into Onyx
  *
- * @param data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *}
+ * @param data An array of objects with update expressions
  * @returns resolves when all operations are complete
  */
-declare function update(data: OnyxUpdate[]): Promise<Array<void | void[]>>;
+declare function update(data: OnyxUpdate[]): Promise<void>;
 declare const Onyx: {
     readonly METHOD: {
         readonly SET: "set";