Skip to content

Commit abddf98

Browse files
committed
chore: header comments
1 parent 04e0273 commit abddf98

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

src/index.ts

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ export type {
2323
VueDatabaseQueryData,
2424
} from './database/utils'
2525

26-
// Firestore
26+
/**
27+
* Firestore
28+
*/
2729
export { useCollection, useDocument, useFirestore } from './firestore'
2830
export { firestoreOptionsDefaults as globalFirestoreOptions } from './firestore/subscribe'
2931
export { firestoreDefaultConverter } from './firestore/utils'
@@ -35,7 +37,9 @@ export type {
3537
VueFirestoreQueryData,
3638
} from './firestore'
3739

38-
// Database options API
40+
/**
41+
* Database Options API
42+
*/
3943
export {
4044
databasePlugin,
4145
// To ease migration
@@ -48,7 +52,9 @@ export type {
4852
FirebaseOption,
4953
} from './database/optionsApi'
5054

51-
// Firestore options API
55+
/**
56+
* Firestore Options API
57+
*/
5258
export {
5359
firestorePlugin,
5460
VueFireFirestoreOptionsAPI,
@@ -59,10 +65,14 @@ export type {
5965
FirestoreOption,
6066
} from './firestore/optionsApi'
6167

62-
// app
68+
/**
69+
* App
70+
*/
6371
export { useFirebaseApp } from './app'
6472

65-
// Auth
73+
/**
74+
* Auth
75+
*/
6676
export {
6777
useCurrentUser,
6878
VueFireAuth,
@@ -71,15 +81,21 @@ export {
7181
updateCurrentUserProfile,
7282
} from './auth'
7383

74-
// SSR
84+
/**
85+
* SSR
86+
*/
7587
export { usePendingPromises } from './ssr/plugin'
7688
export { useSSRInitialState } from './ssr/initialState'
7789

78-
// App Check
90+
/**
91+
* App Check
92+
*/
7993
export { VueFireAppCheck, useAppCheckToken, useAppCheck } from './app-check'
8094
export type { VueFireAppCheckOptions } from './app-check'
8195

82-
// Storage
96+
/**
97+
* Storage
98+
*/
8399
export {
84100
useStorage,
85101
useStorageMetadata,

0 commit comments

Comments
 (0)