Class ContainerToTemplateConverter

A RepresentationConverter that creates a templated representation of a container.

Hierarchy (view full)

BaseTypedRepresentationConverter
- ContainerToTemplateConverter

Index

Constructors

Properties

inputTypes outputTypes

Methods

canHandle getOutputTypes handle handleSafe

Constructors

constructor

new ContainerToTemplateConverter(templateEngine, contentType, identifierStrategy): ContainerToTemplateConverter
Parameters
- templateEngine: TemplateEngine<Dict<unknown>>
- contentType: string
- identifierStrategy: IdentifierStrategy
Returns ContainerToTemplateConverter
Overrides BaseTypedRepresentationConverter.constructor
- Defined in src/storage/conversion/ContainerToTemplateConverter.ts:31

Properties

`Protected`inputTypes

inputTypes: Promise<ValuePreferences>

`Protected`outputTypes

outputTypes: Promise<ValuePreferences>

Methods

canHandle

canHandle(args): Promise<void>
Determines whether the given conversion request is supported, given the available content type conversions:
- Checks if there is a content type for the input.
- Checks if the input type is supported by the parser.
- Checks if the parser can produce one of the preferred output types. Throws an error with details if conversion is not possible.
Parameters
- args: RepresentationConverterArgs
Returns Promise<void>
Overrides BaseTypedRepresentationConverter.canHandle
- Defined in src/storage/conversion/ContainerToTemplateConverter.ts:38

getOutputTypes

getOutputTypes(contentType): Promise<ValuePreferences>
Matches all inputs to all outputs.
Parameters
- contentType: string
Returns Promise<ValuePreferences>
Inherited from BaseTypedRepresentationConverter.getOutputTypes
- Defined in src/storage/conversion/BaseTypedRepresentationConverter.ts:46

handle

handle(input): Promise<Representation>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.
Parameters
- input: RepresentationConverterArgs
  Input that needs to be handled.
Returns Promise<Representation>
A promise resolving when handling is finished.
Overrides BaseTypedRepresentationConverter.handle
- Defined in src/storage/conversion/ContainerToTemplateConverter.ts:45

handleSafe

handleSafe(input): Promise<Representation>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: RepresentationConverterArgs
  Input data that will be handled if it can be handled.
Returns Promise<Representation>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from BaseTypedRepresentationConverter.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41