Merge pull request #26789 from JKobrynski/migrateOnyxSubscribeToTypeS…

…cript [No QA] [TS Migration] migrate onyxSubscribe to TypeScript
Expensify · Sep 7, 2023 · 5668cfe · 5668cfe
2 parents cced02d + 0ce567a
commit 5668cfe
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 20 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -125,7 +125,7 @@
     "react-native-linear-gradient": "^2.8.1",
     "react-native-localize": "^2.2.6",
     "react-native-modal": "^13.0.0",
-    "react-native-onyx": "1.0.70",
+    "react-native-onyx": "1.0.72",
     "react-native-pager-view": "^6.2.0",
     "react-native-pdf": "^6.7.1",
     "react-native-performance": "^4.0.0",

diff --git a/src/libs/onyxSubscribe.js b/src/libs/onyxSubscribe.js
diff --git a/src/libs/onyxSubscribe.ts b/src/libs/onyxSubscribe.ts
@@ -0,0 +1,15 @@
+import Onyx, {ConnectOptions} from 'react-native-onyx';
+import {OnyxKey} from '../ONYXKEYS';
+
+/**
+ * Connect to onyx data. Same params as Onyx.connect(), but returns a function to unsubscribe.
+ *
+ * @param mapping Same as for Onyx.connect()
+ * @return Unsubscribe callback
+ */
+function onyxSubscribe<TKey extends OnyxKey>(mapping: ConnectOptions<TKey>) {
+    const connectionId = Onyx.connect(mapping);
+    return () => Onyx.disconnect(connectionId);
+}
+
+export default onyxSubscribe;