Class RedirectResolver<TUri>

A Uri Resolver that resolves to a new URI and correctly updates the resolution history.

Type Parameters

  • TUri extends string | Uri = string

Hierarchy

Constructors

constructor

Properties

from getStepDescription to

Methods

_tryResolveUri tryResolveUri

Constructors

constructor

  • Construct a RedirectResolver

    Type Parameters

    • TUri extends string | Uri = string

    Parameters

    • from: TUri

      the URI to redirect from

    • to: TUri

      the URI to redirect to

    Returns RedirectResolver<TUri>

Properties

from

from: Uri

Protected getStepDescription

getStepDescription: (() => string)

Type declaration

    • (): string

    • A utility function for generating step descriptions to facilitate resolution context updates

      Returns string

      text describing the URI resolution step

to

to: Uri

Methods

Protected _tryResolveUri

tryResolveUri

  • Resolve a URI to a wrap package, a wrapper, or a URI. Updates the resolution context with the result.

    Parameters

    • uri: Uri

      the URI to resolve

    • client: CoreClient

      a CoreClient instance that may be used to invoke a wrapper that implements the UriResolver interface

    • resolutionContext: IUriResolutionContext

      the current URI resolution context

    Returns Promise<Result<UriPackageOrWrapper, undefined>>

    A Promise with a Result containing either a wrap package, a wrapper, or a URI if successful

    Remarks

    This method calls the internal abstract method _tryResolveUri before updating the resolution context. Implementations are expect to place resolution logic in _tryResolveUri.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc