Home > @uniformdev/redirect > RedirectClient

RedirectClient class

Signature:

Extends: ApiClient<RedirectClientOptions>

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the <code>RedirectClient</code> class

Properties

PropertyModifiersTypeDescription
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<code>static</code>(url: string, trie: PathTrie) => Promise<RedirectResult | undefined>
resetRedirectTrieDataCache() => Promise<void>
upsertRedirect(redirect: RedirectUpsertRequest["redirect"]) => Promise<string>

Methods

MethodModifiersDescription
getAllRedirects(orderBy)
validateRedirect(url, redirectDefinition)<code>static</code>