Skip to content

Commit 52b5a56

Browse files
committed
docs: api VueFireAppcheck
1 parent 256907e commit 52b5a56

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/app-check/index.ts

+15
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,21 @@ export interface VueFireAppCheckOptions extends AppCheckOptions {
2626
debug?: boolean
2727
}
2828

29+
/**
30+
* VueFire AppCheck Module to be added to the `VueFire` Vue plugin options.
31+
*
32+
* @example
33+
*
34+
* ```ts
35+
* import { createApp } from 'vue'
36+
* import { VueFire, VueFireAppCheck } from 'vuefire'
37+
*
38+
* const app = createApp(App)
39+
* app.use(VueFire, {
40+
* modules: [VueFireAppCheck()],
41+
* })
42+
* ```
43+
*/
2944
export function VueFireAppCheck(options: VueFireAppCheckOptions) {
3045
return (firebaseApp: FirebaseApp, app: App) => {
3146
// provide this even on the server for simplicity of usage

0 commit comments

Comments
 (0)