Home > @uniformdev/redirect > RedirectClient

RedirectClient class

Signature:

Extends: ApiClient<RedirectClientOptions>

Constructors

Constructor

Modifiers

Description

(constructor)(options)

Constructs a new instance of the RedirectClient class

Properties

Property

Modifiers

Type

Description

deleteRedirect

(id: string) => Promise<string>

getRedirect

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

getRedirects

(options?: RedirectClientGetRedirects>

getRedirectTrie

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

processUrlAllMatches

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

processUrlBestMatch

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

processUrlBestMatch

static

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

resetRedirectTrieDataCache

() => Promise<void>

upsertRedirect

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

Methods

Method

Modifiers

Description

getAllRedirects(orderBy)

validateRedirect(url, redirectDefinition)

static