Options
All
  • Public
  • Public/Protected
  • All
Menu

A meta converter that takes an array of other converters as input. It chains these converters by finding a path of converters that can go from the given content-type to the given type preferences. In case there are multiple paths, the one with the highest weight gets found. Will error in case no path can be found.

This is not a TypedRepresentationConverter since the supported output types might depend on what is the input content-type.

This converter should be the last in a WaterfallHandler if there are multiple, since it will try to convert any representation with a content-type.

Some suggestions on how this class can be even more optimized should this ever be needed in the future. Most of these decrease computation time at the cost of more memory.

Hierarchy

Index

Constructors

constructor

Properties

Private Readonly converters

Protected Readonly logger

logger: Logger = ...

Methods

canHandle

Private findBest

  • findBest(type: string, preferences: ValuePreferences, paths: ConversionPath[]): undefined | MatchedPath
  • Finds the path from the given list that can convert the given type to the given preferences. If there are multiple matches the one with the highest result weight gets chosen. Will return undefined if there are no matches.

    Parameters

    Returns undefined | MatchedPath

Private findPath

Private generatePath

  • generatePath(inType: string, outPreferences: ValuePreferences): Promise<MatchedPath>
  • Tries to generate the optimal ConversionPath that supports the given parameters, which will then be used to instantiate a specific MatchedPath for those parameters.

    Errors if such a path does not exist.

    Parameters

    Returns Promise<MatchedPath>

handle

handleSafe

Private isMatchedPath

  • isMatchedPath(path: unknown): path is MatchedPath

Private modifyTypeWeights

Private removeBadPaths

  • removeBadPaths(paths: ConversionPath[], maxWeight: number, inType: string, bestMatch?: MatchedPath): ConversionPath[]
  • Filter out paths that can no longer be better than the current best solution. This depends on a valid path already being found, if not all the input paths will be returned.

    Parameters

    • paths: ConversionPath[]

      Paths to filter.

    • maxWeight: number

      The maximum weight in the output preferences.

    • inType: string

      The input type.

    • Optional bestMatch: MatchedPath

      The current best path.

    Returns ConversionPath[]

Private supportedConverters

Private takeStep

  • takeStep(path: ConversionPath): Promise<ConversionPath[]>
  • Finds all converters that could take the output of the given path as input. For each of these converters a new path gets created which is the input path appended by the converter.

    Parameters

    • path: ConversionPath

    Returns Promise<ConversionPath[]>