Class HttpUrlWrap

constructor

• new HttpUrlWrap(url: HttpUrl): HttpUrlWrap

  Create a new wrapper instance.

  Parameters

  • url: HttpUrl

    The URL to wrap

  Returns HttpUrlWrap

ReadonlyformatQueryStringOptions

ReadonlyparseQueryStringOptions

isFrozen

• get isFrozen(): boolean

  Check if wrapper is frozen (read-only).

  Returns boolean

  true if wrapper is frozen, false otherwise

clone

• clone(): HttpUrlWrap

  Clone wrapper with a copy of the URL.

  Returns HttpUrlWrap

  New independent wrapper instance

freeze

• freeze(): this

  Freeze wrapper to prevent modifications.

  Returns this

  This wrapper for method chaining

get

• get<K extends keyof HttpUrl>(name: K): HttpUrl[K]

  Get URL part by name.

  Type Parameters

  • K extends keyof HttpUrl

  Parameters

  • name: K

    URL component name

  Returns HttpUrl[K]

  Value of the URL component

getHost

• getHost(): string

  Get host part (hostname:port or just hostname).

  Returns string

  Host string

getQueryString

• getQueryString(): HttpQueryString

  Get URL query string as parsed object (cached).

  Returns HttpQueryString

  Parsed query string as object

  Throws

  If parse query string fails

isPath

• isPath(value: string | RegExp): boolean

  Match URL pathname against string or regex.

  Parameters

  • value: string | RegExp

    String path or RegExp pattern

  Returns boolean

  true if pathname matches, false otherwise

merge

• merge(url: Partial<HttpUrl>): this

  Merge partial URL object.

  Parameters

  • url: Partial<HttpUrl>

    Partial URL object with properties to update

  Returns this

  This wrapper for method chaining

  Throws

  If wrapper is frozen

reset

• reset(): this

  Clear URL and reset to default.

  Returns this

  This wrapper for method chaining

  Throws

  If wrapper is frozen

set

• set<K extends keyof HttpUrl>(name: K, value: HttpUrl[K]): this

  Set URL part by name.

  Type Parameters

  • K extends keyof HttpUrl

  Parameters

  • name: K

    URL component name

  • value: HttpUrl[K]

    New value for the component

  Returns this

  This wrapper for method chaining

  Throws

  If wrapper is frozen

setQueryString

• setQueryString(queryString: HttpQueryString): this

  Set URL query string from object.

  Parameters

  • queryString: HttpQueryString

    Query string object

  Returns this

  This wrapper for method chaining

  Throws

  If wrapper is frozen

  Throws

  If format query string fails

toAbsolute

• toAbsolute(): string

  Get URL as absolute string.

  Returns string

  Absolute URL string

toObject

• toObject(): HttpUrl

  Get URL as object.

  Returns HttpUrl

  Copy of URL object

toRelative

• toRelative(): string

  Get URL as relative string.

  Returns string

  Relative URL string

StaticfromAbsolute

• fromAbsolute(value: string): HttpUrlWrap

  Factory method to create wrapper from absolute URL string.

  Parameters

  • value: string

    Absolute URL string

  Returns HttpUrlWrap

  New wrapper instance

  Throws

  If URL cannot be parsed

StaticfromRelative

• fromRelative(value: string): HttpUrlWrap

  Factory method to create wrapper from relative URL string.

  Parameters

  • value: string

    Relative URL string

  Returns HttpUrlWrap

  New wrapper instance

  Throws

  If URL cannot be parsed

StaticfromReq

• fromReq(req: { url?: string }): HttpUrlWrap

  Factory method to create wrapper from request-like object.

  Parameters

  • req: { url?: string }

    Object with optional url property

  Returns HttpUrlWrap

  New wrapper instance

  Throws

  If req.url is not defined

StaticfromScratch

• fromScratch(): HttpUrlWrap

  Factory method to create wrapper from scratch.

  Returns HttpUrlWrap

  New wrapper instance