Class RepresentationConverter

Converts a Representation from one media type to another, based on the given preferences.

Hierarchy

AsyncHandler<RepresentationConverterArgs, Representation>
- RepresentationConverter
  - TypedRepresentationConverter

Index

Methods

Methods

canHandle

canHandle(input: RepresentationConverterArgs): Promise<void>

Inherited from AsyncHandler.canHandle
- Defined in src/util/AsyncHandler.ts:13
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: RepresentationConverterArgs
  
  Input data that would be handled potentially.
Returns Promise<void>

A promise resolving if this input can be handled, rejecting with an Error if not.

Abstract handle

handle(input: RepresentationConverterArgs): Promise<Representation>

Inherited from AsyncHandler.handle
- Defined in src/util/AsyncHandler.ts:23
Handles the given input. This should only be done if the canHandle function returned true.

Parameters
- input: RepresentationConverterArgs
  
  Input data that needs to be handled.
Returns Promise<Representation>

A promise resolving when the handling is finished. Return value depends on the given type.

handleSafe

handleSafe(data: RepresentationConverterArgs): Promise<Representation>

Inherited from AsyncHandler.handleSafe
- Defined in src/util/AsyncHandler.ts:33
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- data: RepresentationConverterArgs
  
  The data to handle.
Returns Promise<Representation>

The result of the handle function of the handler.