Home > @uniformdev/redirect > RedirectClient

RedirectClient class

Signature:

Extends: ApiClient<RedirectClientOptions>

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 RedirectClient class

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

Properties

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

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

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

deleteRedirect

</td><td>

</td><td>

(id: string) => Promise<string>

</td><td>

</td></tr> <tr><td>

getRedirect

</td><td>

</td><td>

(options: RedirectClientGetRedirect) => Promise<RedirectDefinition | undefined>

</td><td>

</td></tr> <tr><td>

getRedirects

</td><td>

</td><td>

(options?: RedirectClientGetRedirects>

</td><td>

</td></tr> <tr><td>

getRedirectTrie

</td><td>

</td><td>

(options?: { bypassDataCache?: boolean; }) => Promise<PathTrie>>

</td><td>

</td></tr> <tr><td>

processUrlAllMatches

</td><td>

</td><td>

(url: string, options?: RedirectOptions[]>

</td><td>

</td></tr> <tr><td>

processUrlBestMatch

</td><td>

</td><td>

(url: string, options?: RedirectOptions, useTrie?: boolean) => Promise<RedirectResult | undefined>

</td><td>

</td></tr> <tr><td>

processUrlBestMatch

</td><td>

static

</td><td>

(url: string, trie: PathTrie) => Promise<RedirectResult | undefined>

</td><td>

</td></tr> <tr><td>

resetRedirectTrieDataCache

</td><td>

</td><td>

() => Promise<void>

</td><td>

</td></tr> <tr><td>

upsertRedirect

</td><td>

</td><td>

(redirect: RedirectUpsertRequest['redirect']) => Promise<string>

</td><td>

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

Methods

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

Method

</th><th>

Modifiers

</th><th>

Description

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

getAllRedirects(orderBy)

</td><td>

</td><td>

</td></tr> <tr><td>

validateRedirect(url, redirectDefinition)

</td><td>

static

</td><td>

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