Class HttpUrlWrap

Wrapper class for HTTP message URLs.

Constructors

constructor

new HttpUrlWrap(url: HttpUrl): HttpUrlWrap
Creates a new wrapper instance.
Parameters
- url: HttpUrl
  The URL object to wrap.
Returns HttpUrlWrap

Properties

`Readonly`formatQueryStringOptions

formatQueryStringOptions: IStringifyBaseOptions = {}

Custom options for formatting query strings.

`Readonly`parseQueryStringOptions

parseQueryStringOptions: IParseBaseOptions = {}

Custom options for parsing query strings.

Accessors

isFrozen

get isFrozen(): boolean

Checks if the wrapper is frozen (read-only).

Returns boolean
true if the wrapper is frozen, false otherwise.

Methods

clone

clone(): HttpUrlWrap

Clones the wrapper with a copy of the URL.

Returns HttpUrlWrap
A new independent wrapper instance.

freeze

freeze(): this

Freezes the wrapper to prevent modifications.

Returns this
This wrapper for method chaining.

get

get<K extends keyof HttpUrl>(name: K): HttpUrl[K]
Gets a URL component by name.
Type Parameters
- K extends keyof HttpUrl
Parameters
- name: K
  The name of the URL component.
Returns HttpUrl[K]
The value of the URL component.

getHost

getHost(): string

Gets the host part.

Returns string
The host string.

getQueryString

getQueryString(): HttpQueryString

Gets the URL query string as a parsed object (cached).

Returns HttpQueryString
The parsed query string as an object.

Throws
Error If parsing the query string fails.

isPath

isPath(arg: string | RegExp | (string | RegExp)[]): boolean
Checks if the URL pathname matches a string or regular expression.
Parameters
- arg: string | RegExp | (string | RegExp)[]
  The string path, RegExp pattern to match or array of both.
Returns boolean
true if the pathname matches, false otherwise.

merge

merge(url: Partial<HttpUrl>): this
Merges a partial URL object into the current URL.
Parameters
- url: Partial<HttpUrl>
  The partial URL object with properties to update.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

reset

reset(): this

Resets the URL to default values.

Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

set

set<K extends keyof HttpUrl>(name: K, value: HttpUrl[K]): this
Sets a URL component by name.
Type Parameters
- K extends keyof HttpUrl
Parameters
- name: K
  The name of the URL component to set.
- value: HttpUrl[K]
  The new value for the component.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

setQueryString

setQueryString(queryString: HttpQueryString): this
Sets the URL query string from an object.
Parameters
- queryString: HttpQueryString
  The query string object to set.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

Throws
Error If formatting the query string fails.

toAbsolute

toAbsolute(): string

Returns the URL as an absolute string.

Returns string
The absolute URL string.

toObject

toObject(): HttpUrl

Returns the URL as an object.

Returns HttpUrl
A copy of the URL object.

toRelative

toRelative(): string

Returns the URL as a relative string.

Returns string
The relative URL string.

`Static`fromAbsolute

fromAbsolute(value: string): HttpUrlWrap
Factory method to create a wrapper from an absolute URL string.
Parameters
- value: string
  The absolute URL string.
Returns HttpUrlWrap
A new wrapper instance.

Throws
Error If the URL cannot be parsed.

`Static`fromRelative

fromRelative(value: string): HttpUrlWrap
Factory method to create a wrapper from a relative URL string.
Parameters
- value: string
  The relative URL string.
Returns HttpUrlWrap
A new wrapper instance.

Throws
Error If the URL cannot be parsed.

`Static`fromReq

fromReq(req: { url?: string }): HttpUrlWrap
Factory method to create a wrapper from a request-like object.
Parameters
- req: { url?: string }
  The object with an optional url property.
Returns HttpUrlWrap
A new wrapper instance.

Throws
Error If req.url is not defined.

`Static`fromScratch

fromScratch(): HttpUrlWrap

Factory method to create a wrapper from scratch.

Returns HttpUrlWrap
A new wrapper instance with default values.