Class BasicRequestParser

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

Hierarchy

RequestParser
- BasicRequestParser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasicRequestParser(args: BasicRequestParserArgs): BasicRequestParser

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

Properties

Private Readonly bodyParser

bodyParser: BodyParser

Private Readonly conditionsParser

conditionsParser: ConditionsParser

Private Readonly metadataParser

metadataParser: MetadataParser

Private Readonly preferenceParser

preferenceParser: PreferenceParser

Private Readonly targetExtractor

targetExtractor: TargetExtractor

Methods

canHandle

canHandle(input: HttpRequest): Promise<void>

Inherited from RequestParser.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: HttpRequest
  Input 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: HttpRequest): Promise<Operation>

Overrides RequestParser.handle
- Defined in src/http/input/BasicRequestParser.ts:40
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- request: HttpRequest
Returns Promise<Operation>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: HttpRequest): Promise<Operation>

Inherited from RequestParser.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
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: HttpRequest
  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.