Class BasicRequestParser

Creates an Operation from an incoming HttpRequest by aggregating the results of a TargetExtractor, PreferenceParser, MetadataParser, and BodyParser.

Hierarchy

RequestParser
- BasicRequestParser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasicRequestParser(args: BasicRequestParserArgs): BasicRequestParser

Overrides RequestParser.constructor
- Defined in src/ldp/http/BasicRequestParser.ts:29
Parameters
- args: BasicRequestParserArgs
Returns BasicRequestParser

Properties

Private Readonly bodyParser

bodyParser: BodyParser

Private Readonly metadataParser

metadataParser: MetadataParser

Private Readonly preferenceParser

preferenceParser: PreferenceParser

Private Readonly targetExtractor

targetExtractor: TargetExtractor

Methods

canHandle

canHandle(input: Guarded<IncomingMessage>): Promise<void>

Inherited from RequestParser.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: Guarded<IncomingMessage>
  
  Input data that could potentially be handled.
Returns Promise<void>

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

handle

handle(request: Guarded<IncomingMessage>): Promise<Operation>

Overrides RequestParser.handle
- Defined in src/ldp/http/BasicRequestParser.ts:36
Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

Parameters
- request: Guarded<IncomingMessage>
Returns Promise<Operation>

handleSafe

handleSafe(input: Guarded<IncomingMessage>): Promise<Operation>

Inherited from RequestParser.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: Guarded<IncomingMessage>
  
  Input data that will be handled if it can be handled.
Returns Promise<Operation>

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