Class ExtendableUriResolver

A Uri Resolver that delegates resolution to wrappers implementing the URI Resolver Extension Interface.

Hierarchy

Constructors

constructor

Properties

_resolverName extInterfaceUris getStepDescription defaultExtInterfaceUris

Methods

getUriResolvers tryResolveUri tryResolveUriWithResolvers

Constructors

constructor

  • Create an ExtendableUriResolver

    Parameters

    • Optional extInterfaceUris: Uri[]

      URI Resolver Interface URIs

    • Optional resolverName: string

      Name to use in resolution history output

    Returns ExtendableUriResolver

Properties

Private Readonly _resolverName

_resolverName: any

Readonly extInterfaceUris

extInterfaceUris: Uri[]

The active interface URIs to which implementations should be registered

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

Static defaultExtInterfaceUris

defaultExtInterfaceUris: Uri[]

The supported interface URIs to which resolver-ext implementations should be registered

Methods

getUriResolvers

  • Get a list of URI Resolvers

    Parameters

    • uri: Uri

      the URI to query for resolvers

    • client: CoreClient

      a CoreClient instance that can be used to make an invocation

    • resolutionContext: IUriResolutionContext

      the current URI resolution context

    Returns Promise<Result<IUriResolver<unknown>[], Error>>

    a list of IUriResolver or an error

tryResolveUri

  • Resolve a URI to a wrap package, a wrapper, or a URI. Attempts resolution with each the URI Resolver Extension wrappers sequentially.

    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, Error>>

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

Protected tryResolveUriWithResolvers

  • Using each of the aggregated resolvers, attempt to resolve a URI

    Parameters

    • uri: Uri

      the URI to resolve

    • client: CoreClient

      a CoreClient instance that can be used to make an invocation

    • resolvers: IUriResolver<unknown>[]

      a list of IUriResolver implementations

    • resolutionContext: IUriResolutionContext

      a resolution context to update when resolving URIs

    Returns Promise<Result<UriPackageOrWrapper, Error>>

    a URI, a Wrap Package, or a Wrapper (or an error)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc