Home > @uniformdev/canvas > RouteClient

RouteClient class

Resolves a route using Uniform Project Map and Uniform Redirects, returning a composition, redirection, or not found result.

Signature:

Extends: ApiClient<RouteClientOptions>

Constructors

<table><thead><tr><th>

Constructor

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

(constructor)(options)

</td><td>

</td><td>

Constructs a new instance of the RouteClient class

</td></tr> </tbody></table>

Methods

<table><thead><tr><th>

Method

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

getRoute(options)

</td><td>

</td><td>

Fetches lists of Canvas compositions, optionally by type

</td></tr> </tbody></table>