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

# useSuggestRoutes

## Overview

A hook that returns the N best matching routes for the current path with
similarity scores. Intended for use with `SuggestionList` in system 404 views.

## Signature

`useSuggestRoutes(options)`

### Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <span id="param-options">options</span> | `object` | no |  |

#### options Properties

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="param-options-limit">limit</span> | `number` |  |  | Maximum number of suggestions to return. |

### Returns

`Readonly`

## Source

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