---
url: "https://vueda.dev/v3/reference/api/js/use/useSuggestRoute.md"
title: "use/useSuggestRoute"
---

# use/useSuggestRoute

## Overview

Suggests the best matching route for the current path using string similarity against all registered routes.

## Methods

- [useSuggestRoute](/v3/reference/api/js/use/useSuggestRoute/functions/useSuggestRoute.md) - A hook to suggest a route based on the current route.
- [useSuggestRoutes](/v3/reference/api/js/use/useSuggestRoute/functions/useSuggestRoutes.md) - A hook that returns the N best matching routes for the current path with similarity scores.

## Types

### [RouteMatch](/v3/reference/api/js/use/useSuggestRoute/types/RouteMatch.md)

| Name | Type | Description |
| --- | --- | --- |
| matchedPath | string |  |
| score | number |  |

### [SuggestedRoute](/v3/reference/api/js/use/useSuggestRoute/types/SuggestedRoute.md)

| Name | Type | Description |
| --- | --- | --- |
| matchedPath | string |  |
| route | object |  |
| score | number |  |

## Source

`client/lib/use/useSuggestRoute.js:1`