Class OriginalUrlExtractor

Reconstructs the original URL of an incoming HttpRequest.

Hierarchy

TargetExtractor
- OriginalUrlExtractor

Index

Constructors

constructor

Properties

includeQueryString

Methods

Constructors

constructor

new OriginalUrlExtractor(options?: { includeQueryString?: boolean }): OriginalUrlExtractor

Inherited from TargetExtractor.constructor
- Defined in src/ldp/http/OriginalUrlExtractor.ts:12
Parameters
- options: { includeQueryString?: boolean } = ...
  - Optional includeQueryString?: boolean
Returns OriginalUrlExtractor

Properties

Private Readonly includeQueryString

includeQueryString: boolean

Methods

canHandle

canHandle(input: { request: HttpRequest }): Promise<void>

Inherited from TargetExtractor.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: { request: HttpRequest }
  
  Input data that could potentially be handled.
  - request: HttpRequest
Returns Promise<void>

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

handle

handle(__namedParameters: { request: HttpRequest }): Promise<ResourceIdentifier>

Overrides TargetExtractor.handle
- Defined in src/ldp/http/OriginalUrlExtractor.ts:19
Parameters
- __namedParameters: { request: HttpRequest }
  - request: HttpRequest
Returns Promise<ResourceIdentifier>

handleSafe

handleSafe(input: { request: HttpRequest }): Promise<ResourceIdentifier>

Inherited from TargetExtractor.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: { request: HttpRequest }
  
  Input data that will be handled if it can be handled.
  - request: HttpRequest
Returns Promise<ResourceIdentifier>

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