Class ConstantMetadataWriter

A MetadataWriter that takes a constant map of header names and values.

Hierarchy

MetadataWriter
- ConstantMetadataWriter

Index

Constructors

constructor

Properties

headers

Methods

Constructors

constructor

new ConstantMetadataWriter(headers: Record<string, string>): ConstantMetadataWriter

Inherited from MetadataWriter.constructor
- Defined in src/ldp/http/metadata/ConstantMetadataWriter.ts:9
Parameters
- headers: Record<string, string>
Returns ConstantMetadataWriter

Properties

Private Readonly headers

headers: [string, string][]

Methods

canHandle

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

Inherited from MetadataWriter.canHandle
- Defined in src/util/handlers/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 could potentially be handled.
  - metadata: RepresentationMetadata
  - response: HttpResponse
Returns Promise<void>

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

handle

handle(__namedParameters: { response: HttpResponse }): Promise<void>

Overrides MetadataWriter.handle
- Defined in src/ldp/http/metadata/ConstantMetadataWriter.ts:16
Parameters
- __namedParameters: { response: HttpResponse }
  - response: HttpResponse
Returns Promise<void>

handleSafe

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

Inherited from MetadataWriter.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:35
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
- input: { metadata: RepresentationMetadata; response: HttpResponse }
  
  Input data that will be handled if it can be handled.
  - metadata: RepresentationMetadata
  - response: HttpResponse
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.