useRoute

Returns the current route. See 'RouterRoute' for more information.

import { useRoute } from '@kitbag/router'

const route = useRoute()

This composable can also be used to narrow the type of the route by passing in the name of the expected route. It works the same way as the isRoute type guard. However if the current route does not match the expected route, a UseRouteInvalidRouteError will be thrown.

const route = useRoute('profile')

Exact

The route will be a union of all possible routes as long as the name matches any of the matches in the current route. This includes any parent routes. To match a specific route, you can use the exact option.

const route = useRoute('profile', { exact: true })

Read more about route narrowing.