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.

  • The algorithm could start on both ends of a possible path and work towards the middle.
  • When creating a path, store the list of unused converters instead of checking every step.
  • Caching: https://github.com/CommunitySolidServer/CommunitySolidServer/issues/832
  • Making sure each intermediate type is only used once.
  • The TypedRepresentationConverter interface could potentially be updated so paths only differing in intermediate types can be combined.

Hierarchy

Constructors

Properties

logger: Logger = ...

Methods

  • Finds the path from the given list that can convert 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

    • paths: ConversionPath[]

    Returns undefined | ConversionPath

  • 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<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.

    • Optional bestMatch: ConversionPath

      The current best path.

    Returns 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

    Returns Promise<ConversionPath[]>