Class BasicConditionsParser

Creates a Conditions object based on the the following headers:

If-Modified-Since
If-Unmodified-Since
If-Match
If-None-Match

Implementation based on RFC7232

Hierarchy

ConditionsParser
- BasicConditionsParser

Index

Constructors

constructor

Properties

logger

Methods

Constructors

constructor

new BasicConditionsParser(): BasicConditionsParser

Inherited from ConditionsParser.constructor
Returns BasicConditionsParser

Properties

Protected Readonly logger

logger: Logger = ...

Methods

canHandle

canHandle(input: HttpRequest): Promise<void>

Inherited from ConditionsParser.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<undefined | Conditions>

Overrides ConditionsParser.handle
- Defined in src/http/input/conditions/BasicConditionsParser.ts:20
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<undefined | Conditions>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: HttpRequest): Promise<undefined | Conditions>

Inherited from ConditionsParser.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<undefined | Conditions>
A promise resolving if the input can be handled, rejecting with an Error if not.

Private parseDateHeader

parseDateHeader(request: HttpRequest, header: "if-modified-since" | "if-unmodified-since"): undefined | Date

- Defined in src/http/input/conditions/BasicConditionsParser.ts:48
Converts a request header containing a datetime string to an actual Date object. Undefined if there is no value for the given header name.

Parameters
- request: HttpRequest
- header: "if-modified-since" | "if-unmodified-since"
Returns undefined | Date

Private parseTagHeader

parseTagHeader(request: HttpRequest, header: "if-match" | "if-none-match"): undefined | string[]

- Defined in src/http/input/conditions/BasicConditionsParser.ts:60
Converts a request header containing ETags to an array of ETags. Undefined if there is no value for the given header name.

Parameters
- request: HttpRequest
- header: "if-match" | "if-none-match"
Returns undefined | string[]