Class BodyParser

Parses the body of an incoming HttpRequest and converts it to a Representation.

Hierarchy

AsyncHandler<BodyParserArgs, Representation | undefined>
- BodyParser

Index

Constructors

constructor

Methods

Constructors

constructor

new BodyParser(): BodyParser

Inherited from AsyncHandler.constructor

Returns BodyParser

Methods

canHandle

canHandle(input: BodyParserArgs): Promise<void>

Inherited from AsyncHandler.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: BodyParserArgs
  
  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.

Abstract handle

handle(input: BodyParserArgs): Promise<undefined | Representation>

Inherited from AsyncHandler.handle
- Defined in src/util/handlers/AsyncHandler.ts:24
Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

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

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

handleSafe

handleSafe(input: BodyParserArgs): Promise<undefined | Representation>

Inherited from AsyncHandler.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: BodyParserArgs
  
  Input data that will be handled if it can be handled.
Returns Promise<undefined | Representation>

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