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: firestore/README.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -126,6 +126,7 @@ The `useCollectionData` hook takes the following parameters:
126
126
-`snapshotListenOptions`: (optional) `firebase.firestore.SnapshotListenOptions` to customise how the collection is loaded
127
127
-`snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
128
128
-`transform`: (optional) a function that receives the raw `firebase.firestore.DocumentData` for each item in the collection to allow manual transformation of the data where required by the application. See [`Transforming data`](#transforming-data) below.
129
+
-`initialValue`: (optional) the initial value returned by the hook, until data from the firestore query has loaded
129
130
130
131
Returns:
131
132
@@ -150,6 +151,7 @@ The `useCollectionDataOnce` hook takes the following parameters:
150
151
-`refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
151
152
-`snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
152
153
-`transform`: (optional) a function that receives the raw `firebase.firestore.DocumentData` for each item in the collection to allow manual transformation of the data where required by the application. See [`Transforming data`](#transforming-data) below.
154
+
-`initialValue`: (optional) the initial value returned by the hook, until data from the firestore query has loaded
153
155
154
156
Returns:
155
157
@@ -239,6 +241,7 @@ The `useDocumentData` hook takes the following parameters:
239
241
-`snapshotListenOptions`: (optional) `firebase.firestore.SnapshotListenOptions` to customise how the collection is loaded
240
242
-`snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
241
243
-`transform`: (optional) a function that receives the raw `firebase.firestore.DocumentData` to allow manual transformation of the data where required by the application. See [`Transforming data`](#transforming-data) below.
244
+
-`initialValue`: (optional) the initial value returned by the hook, until data from the firestore query has loaded
242
245
243
246
Returns:
244
247
@@ -263,6 +266,7 @@ The `useDocumentDataOnce` hook takes the following parameters:
263
266
-`refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
264
267
-`snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
265
268
-`transform`: (optional) a function that receives the raw `firebase.firestore.DocumentData` to allow manual transformation of the data where required by the application. See [`Transforming data`](#transforming-data) below.
269
+
-`initialValue`: (optional) the initial value returned by the hook, until data from the firestore query has loaded
0 commit comments