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

ResolverWithHistory
- RedirectResolver

Index

Constructors

Properties

Methods

_tryResolveUri getStepDescription tryResolveUri

Constructors

constructor

new RedirectResolver<TUri>(from, to): RedirectResolver<TUri>
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>
Overrides ResolverWithHistory.constructor
- Defined in packages/uri-resolvers/src/redirects/RedirectResolver.ts:28

Properties

from

from: Uri

to

to: Uri

Methods

`Protected` _tryResolveUri

_tryResolveUri(uri): Promise<Result<UriPackageOrWrapper, undefined>>
Resolve a URI to a new URI
Parameters
- uri: Uri
  
  the URI to resolve
Returns Promise<Result<UriPackageOrWrapper, undefined>>
A Promise with a Result containing a URI if successful
Overrides ResolverWithHistory._tryResolveUri
- Defined in packages/uri-resolvers/src/redirects/RedirectResolver.ts:50

`Protected` getStepDescription

getStepDescription(): string
A utility function for generating step descriptions to facilitate resolution context updates

Returns string
text describing the URI resolution step
Overrides ResolverWithHistory.getStepDescription
- Defined in packages/uri-resolvers/src/redirects/RedirectResolver.ts:40

tryResolveUri

tryResolveUri(uri, client, resolutionContext): Promise<Result<UriPackageOrWrapper, undefined>>
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.
Inherited from ResolverWithHistory.tryResolveUri
- Defined in packages/uri-resolvers/src/helpers/ResolverWithHistory.ts:29

Generated using TypeDoc