Class MetadataWriter

A serializer that converts metadata to headers for an HttpResponse.

Hierarchy

AsyncHandler<{ metadata: RepresentationMetadata; response: HttpResponse }>
- MetadataWriter

Index

Constructors

constructor

Methods

Constructors

constructor

new MetadataWriter(): MetadataWriter

Inherited from AsyncHandler.constructor

Returns MetadataWriter

Methods

canHandle

canHandle(input: { metadata: RepresentationMetadata; response: HttpResponse }): 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: { metadata: RepresentationMetadata; response: HttpResponse }
  
  Input data that would be handled potentially.
  - metadata: RepresentationMetadata
  - response: HttpResponse
Returns Promise<void>

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

Abstract handle

handle(input: { metadata: RepresentationMetadata; response: HttpResponse }): Promise<void>

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: { metadata: RepresentationMetadata; response: HttpResponse }
  
  Input data that needs to be handled.
  - metadata: RepresentationMetadata
  - response: HttpResponse
Returns Promise<void>

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

handleSafe

handleSafe(data: { metadata: RepresentationMetadata; response: HttpResponse }): Promise<void>

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: { metadata: RepresentationMetadata; response: HttpResponse }
  
  The data to handle.
  - metadata: RepresentationMetadata
  - response: HttpResponse
Returns Promise<void>

The result of the handle function of the handler.