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
options	object	no

options Properties

Name	Type	Required	Default	Description
limit	number			Maximum number of suggestions to return.

Returns

Readonly

Source

client/lib/use/useSuggestRoute.js:146