You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/Onyx.ts
+35-3Lines changed: 35 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -81,10 +81,11 @@ function init({
81
81
82
82
/**
83
83
* Connects to an Onyx key given the options passed and listens to its changes.
84
+
* @deprecated Use `Onyx.connectWithoutView()` instead.
84
85
*
85
86
* @example
86
87
* ```ts
87
-
* const connection = Onyx.connect({
88
+
* const connection = Onyx.connectWithoutView({
88
89
* key: ONYXKEYS.SESSION,
89
90
* callback: onSessionChange,
90
91
* });
@@ -107,20 +108,48 @@ function connect<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKey>): Co
107
108
returnconnectionManager.connect(connectOptions);
108
109
}
109
110
111
+
/**
112
+
* Connects to an Onyx key given the options passed and listens to its changes.
113
+
*
114
+
* @example
115
+
* ```ts
116
+
* const connection = Onyx.connectWithoutView({
117
+
* key: ONYXKEYS.SESSION,
118
+
* callback: onSessionChange,
119
+
* });
120
+
* ```
121
+
*
122
+
* @param connectOptions The options object that will define the behavior of the connection.
123
+
* @param connectOptions.key The Onyx key to subscribe to.
124
+
* @param connectOptions.callback A function that will be called when the Onyx data we are subscribed changes.
125
+
* @param connectOptions.waitForCollectionCallback If set to `true`, it will return the entire collection to the callback as a single object.
126
+
* @param connectOptions.withOnyxInstance The `withOnyx` class instance to be internally passed. **Only used inside `withOnyx()` HOC.**
127
+
* @param connectOptions.statePropertyName The name of the component's prop that is connected to the Onyx key. **Only used inside `withOnyx()` HOC.**
128
+
* @param connectOptions.displayName The component's display name. **Only used inside `withOnyx()` HOC.**
129
+
* @param connectOptions.selector This will be used to subscribe to a subset of an Onyx key's data. **Only used inside `useOnyx()` hook or `withOnyx()` HOC.**
130
+
* Using this setting on `useOnyx()` or `withOnyx()` can have very positive performance benefits because the component will only re-render
131
+
* when the subset of data changes. Otherwise, any change of data on any property would normally
132
+
* cause the component to re-render (and that can be expensive from a performance standpoint).
133
+
* @returns The connection object to use when calling `Onyx.disconnect()`.
0 commit comments