react-native-onyx 3.0.121 → 3.0.123

package/API.md

@@ -15,9 +15,6 @@ This method will be deprecated soon. Please use <code>Onyx.connectWithoutView()<
 <dt><a href="#connectWithoutView">connectWithoutView(connectOptions)</a> ⇒</dt>
 <dd><p>Connects to an Onyx key given the options passed and listens to its changes.</p>
 </dd>
-<dt><a href="#disconnect">disconnect(connection)</a></dt>
-<dd><p>Disconnects and removes the listener from the Onyx key.</p>
-</dd>
 <dt><a href="#set">set(key, value, options)</a></dt>
 <dd><p>Write a value to our store with the given key</p>
 </dd>
@@ -91,7 +88,7 @@ Connects to an Onyx key given the options passed and listens to its changes.
 This method will be deprecated soon. Please use `Onyx.connectWithoutView()` instead.
 
 **Kind**: global function  
-**Returns**: The `Connection` handle to use when calling `Onyx.disconnect()`.  
+**Returns**: The `Connection` handle whose `unsubscribe()` stops this subscription.  
 
 | Param | Description |
 | --- | --- |
@@ -118,7 +115,7 @@ cache after any same-tick writes have applied.
 Connects to an Onyx key given the options passed and listens to its changes.
 
 **Kind**: global function  
-**Returns**: The `Connection` handle to use when calling `Onyx.disconnect()`.  
+**Returns**: The `Connection` handle whose `unsubscribe()` stops this subscription.  
 
 | Param | Description |
 | --- | --- |
@@ -139,26 +136,6 @@ object whenever any member changes; signature `(collection, collectionKey)`.
 For any other key, the callback fires with the value at that key; signature
 `(value, key)`. Initial fire is deferred via `scheduleInitialSubscriberNotification` so it reads
 cache after any same-tick writes have applied.
-<a name="disconnect"></a>
-
-## disconnect(connection)
-Disconnects and removes the listener from the Onyx key.
-
-**Kind**: global function  
-
-| Param | Description |
-| --- | --- |
-| connection | Connection object returned by calling `Onyx.connect()` or `Onyx.connectWithoutView()`. |
-
-**Example**  
-```ts
-const connection = Onyx.connectWithoutView({
-    key: ONYXKEYS.SESSION,
-    callback: onSessionChange,
-});
-
-Onyx.disconnect(connection);
-```
 <a name="set"></a>
 
 ## set(key, value, options)

package/README.md

@@ -130,10 +130,10 @@ const connection = Onyx.connectWithoutView({
 });
 ```
 
-To teardown the subscription call `Onyx.disconnect()` with the connection returned from `Onyx.connectWithoutView()`. It's recommended to clean up subscriptions anytime you are connecting from within a function to prevent memory leaks.
+To teardown the subscription call `unsubscribe()` on the connection returned from `Onyx.connectWithoutView()`. It's recommended to clean up subscriptions anytime you are connecting from within a function to prevent memory leaks.
 
 ```javascript
-Onyx.disconnect(connection);
+connection.unsubscribe();
 ```
 
 We can also access values inside React function components via the `useOnyx()` [hook](https://react.dev/reference/react/hooks). When the data changes the component will re-render.

package/dist/Onyx.d.ts

@@ -23,7 +23,7 @@ declare function init({ keys, initialKeyStates, evictableKeys, shouldSyncMultipl
  * @param connectOptions The options object that will define the behavior of the connection.
  * @param connectOptions.key The Onyx key to subscribe to.
  * @param connectOptions.callback A function that will be called when the Onyx data we are subscribed changes.
- * @returns The `Connection` handle to use when calling `Onyx.disconnect()`.
+ * @returns The `Connection` handle whose `unsubscribe()` stops this subscription.
  */
 declare function connect<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKey>): Connection;
 /**
@@ -46,25 +46,9 @@ declare function connect<TKey extends OnyxKey>(connectOptions: ConnectOptions<TK
  * @param connectOptions The options object that will define the behavior of the connection.
  * @param connectOptions.key The Onyx key to subscribe to.
  * @param connectOptions.callback A function that will be called when the Onyx data we are subscribed changes.
- * @returns The `Connection` handle to use when calling `Onyx.disconnect()`.
+ * @returns The `Connection` handle whose `unsubscribe()` stops this subscription.
  */
 declare function connectWithoutView<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKey>): Connection;
-/**
- * Disconnects and removes the listener from the Onyx key.
- *
- * @example
- * ```ts
- * const connection = Onyx.connectWithoutView({
- *     key: ONYXKEYS.SESSION,
- *     callback: onSessionChange,
- * });
- *
- * Onyx.disconnect(connection);
- * ```
- *
- * @param connection Connection object returned by calling `Onyx.connect()` or `Onyx.connectWithoutView()`.
- */
-declare function disconnect(connection: Connection): void;
 /**
  * Write a value to our store with the given key
  *
@@ -208,7 +192,6 @@ declare const Onyx: {
     };
     connect: typeof connect;
     connectWithoutView: typeof connectWithoutView;
-    disconnect: typeof disconnect;
     set: typeof set;
     multiSet: typeof multiSet;
     merge: typeof merge;

package/dist/Onyx.js

@@ -131,7 +131,7 @@ function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], shouldSync
  * @param connectOptions The options object that will define the behavior of the connection.
  * @param connectOptions.key The Onyx key to subscribe to.
  * @param connectOptions.callback A function that will be called when the Onyx data we are subscribed changes.
- * @returns The `Connection` handle to use when calling `Onyx.disconnect()`.
+ * @returns The `Connection` handle whose `unsubscribe()` stops this subscription.
  */
 function connect(connectOptions) {
     const { key, callback } = connectOptions;
@@ -220,32 +220,11 @@ function connect(connectOptions) {
  * @param connectOptions The options object that will define the behavior of the connection.
  * @param connectOptions.key The Onyx key to subscribe to.
  * @param connectOptions.callback A function that will be called when the Onyx data we are subscribed changes.
- * @returns The `Connection` handle to use when calling `Onyx.disconnect()`.
+ * @returns The `Connection` handle whose `unsubscribe()` stops this subscription.
  */
 function connectWithoutView(connectOptions) {
     return connect(connectOptions);
 }
-/**
- * Disconnects and removes the listener from the Onyx key.
- *
- * @example
- * ```ts
- * const connection = Onyx.connectWithoutView({
- *     key: ONYXKEYS.SESSION,
- *     callback: onSessionChange,
- * });
- *
- * Onyx.disconnect(connection);
- * ```
- *
- * @param connection Connection object returned by calling `Onyx.connect()` or `Onyx.connectWithoutView()`.
- */
-function disconnect(connection) {
-    if (!connection) {
-        return;
-    }
-    connection.unsubscribe();
-}
 /**
  * Write a value to our store with the given key
  *
@@ -706,7 +685,6 @@ const Onyx = {
     METHOD: OnyxUtils_1.default.METHOD,
     connect,
     connectWithoutView,
-    disconnect,
     set,
     multiSet,
     merge,

package/dist/types.d.ts

@@ -353,7 +353,7 @@ type MixedOperationsQueue = {
 };
 /**
  * Represents a connection to an Onyx key, returned by `Onyx.connect()`/`Onyx.connectWithoutView()`.
- * Pass it to `Onyx.disconnect()` to stop receiving callbacks for this subscription.
+ * Call its `unsubscribe()` to stop receiving callbacks for this subscription.
  */
 type Connection = {
     /** Unsubscribe this connection. Idempotent. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "3.0.121",
+  "version": "3.0.123",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",