Class BaseUrlExtractor

A SettingsExtractor that that generates the base URL based on the input baseUrl value, or by using the port if the first isn't provided.

Hierarchy

SettingsExtractor
- BaseUrlExtractor

Index

Constructors

constructor

Properties

defaultPort

Methods

Constructors

constructor

new BaseUrlExtractor(defaultPort?: number): BaseUrlExtractor

Overrides SettingsExtractor.constructor
- Defined in src/init/variables/extractors/BaseUrlExtractor.ts:12
Parameters
- defaultPort: number = 3000
Returns BaseUrlExtractor

Properties

Private Readonly defaultPort

defaultPort: number

Methods

canHandle

canHandle(input: Settings): Promise<void>

Inherited from SettingsExtractor.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: Settings
  
  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(args: Settings): Promise<unknown>

Overrides SettingsExtractor.handle
- Defined in src/init/variables/extractors/BaseUrlExtractor.ts:17
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- args: Settings
Returns Promise<unknown>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: Settings): Promise<unknown>

Inherited from SettingsExtractor.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: Settings
  
  Input data that will be handled if it can be handled.
Returns Promise<unknown>
A promise resolving if the input can be handled, rejecting with an Error if not.