Class UrlParser

UrlParser class is used to parse and validate env variables of type URL. UrlParser

Implements

Since

v0.2.5

Implements

IConfigParser<URL, URL>

Index

Constructors

Properties

Methods

parse toLogString toString

Constructors

constructor

new UrlParser(properties?: UrlParserProps): UrlParser
Create a new UrlParser
Parameters
- properties: UrlParserProps = {}
  Properties for the UrlParser
Returns UrlParser
- Defined in packages/variable-util/src/parsers/UrlParser.ts:29

Properties

name

name: string = 'urlParser'

name of the parser

Methods

parse

parse(__namedParameters: ParserProps): URL
Config parser function
Parameters
- __namedParameters: ParserProps
Returns URL

Throws
Error if parsing fails
Implementation of IConfigParser.parse
- Defined in packages/variable-util/src/parsers/UrlParser.ts:33

toLogString

toLogString(value: URL): string
Optional build readable string from value for log (can hide sensitive part from logs) else toString is used
Parameters
- value: URL
  value to log
Returns string
Implementation of IConfigParser.toLogString
- Defined in packages/variable-util/src/parsers/UrlParser.ts:41

toString

toString(value: URL): string
Build readable string from value
Parameters
- value: URL
Returns string
Implementation of IConfigParser.toString
- Defined in packages/variable-util/src/parsers/UrlParser.ts:37