docs: show default value example for useRouteQuery (vitest-dev#643)

chaii3 · Jul 23, 2021 · 2591fcd · 2591fcd
1 parent cb1b777
commit 2591fcd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/router/useRouteQuery/index.md b/packages/router/useRouteQuery/index.md
@@ -13,6 +13,8 @@ import { useRouteQuery } from '@vueuse/router'
 
 const search = useRouteQuery('search')
 
+const search = useRouteQuery('search', 'foo') // or with a default value
+
 console.log(search.value) // route.query.search
 search.value = 'foobar' // router.replace({ query: { search: 'foobar' } })
 ```
@@ -25,6 +27,7 @@ search.value = 'foobar' // router.replace({ query: { search: 'foobar' } })
 export declare function useRouteQuery(
   name: string
 ): Ref<null | string | string[]>
+
 export declare function useRouteQuery<
   T extends null | string | string[] = null | string | string[]
 >(name: string, defaultValue?: T, options?: ReactiveRouteOptions): Ref<T>