diff --git a/packages/router/useRouteQuery/index.md b/packages/router/useRouteQuery/index.md index ca36eb8699c7..eeb5c8062bab 100644 --- 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 + export declare function useRouteQuery< T extends null | string | string[] = null | string | string[] >(name: string, defaultValue?: T, options?: ReactiveRouteOptions): Ref