Class BuildURI

Mutable builder for constructing and manipulating URIs.

BuildURI provides a fluent API for constructing URIs by chaining method calls. Unlike URI, BuildURI is mutable and allows modification of all URI components (protocol, hostname, port, pathname, search params, hash).

Example

const uri = BuildURI.from('https://example.com')
  .pathname('/api/users')
  .setParam('page', '1')
  .setParam('limit', '10')
  .toString();
// Result: "https://example.com/api/users?limit=10&page=1"

// Building from scratch
const uri2 = BuildURI.from()
  .protocol('https')
  .hostname('api.example.com')
  .port('8080')
  .pathname('/v1/data')
  .URI(); // Convert to immutable URI

Implements

URIInterface<BuildURI>

Index

Constructors

`Private`constructor

new BuildURI(url: WritableURL): BuildURI
Parameters
- url: WritableURL
Returns BuildURI
- Defined in uri.ts:308

Properties

_url

_url: WritableURL

Accessors

getParams

get getParams(): Iterable<[string, string]>
Returns Iterable<[string, string]>
Implementation of URIInterface.getParams
- Defined in uri.ts:451

onlyHostAndSchema

get onlyHostAndSchema(): string
Returns string
- Defined in uri.ts:496

withoutHostAndSchema

get withoutHostAndSchema(): string
Returns string
- Defined in uri.ts:500

Methods

`Static`is

is(value: unknown): value is BuildURI
Parameters
- value: unknown
Returns value is BuildURI
- Defined in uri.ts:312

`Static`from

from(strURLUri?: CoerceURI, defaultProtocol?: string): BuildURI
Parameters
- OptionalstrURLUri: CoerceURI
- defaultProtocol: string = "file:"
Returns BuildURI
- Defined in uri.ts:318

match

match(other: CoerceURI): MatchResult
Parameters
- other: CoerceURI
Returns MatchResult
Implementation of URIInterface.match
- Defined in uri.ts:322

port

port(p: string): BuildURI
Parameters
- p: string
Returns BuildURI
- Defined in uri.ts:326

hostname

hostname(h: string): BuildURI
Parameters
- h: string
Returns BuildURI
- Defined in uri.ts:331

protocol

protocol(p: string): BuildURI
Parameters
- p: string
Returns BuildURI
- Defined in uri.ts:336

pathname

pathname(p: string): BuildURI
Parameters
- p: string
Returns BuildURI
- Defined in uri.ts:344

hash

hash(h: string): BuildURI
Parameters
- h: string
Returns BuildURI
- Defined in uri.ts:349

resolve

resolve(p: CoerceURI): BuildURI
Parameters
- p: CoerceURI
Returns BuildURI
- Defined in uri.ts:356

appendRelative

appendRelative(p: CoerceURI): BuildURI
Parameters
- p: CoerceURI
Returns BuildURI
- Defined in uri.ts:374

cleanParams

cleanParams(...remove: (string | string[])[]): BuildURI
Parameters
- ...remove: (string | string[])[]
Returns BuildURI
- Defined in uri.ts:403

searchParams

searchParams(
val: Record<string, string | number | boolean | Date | null | undefined>,
mode?: "reset" | "merge",
): BuildURI
Parameters
- val: Record<string, string | number | boolean | Date | null | undefined>
- mode: "reset" | "merge" = "reset"
Returns BuildURI
- Defined in uri.ts:413

hashParams

hashParams(
val: Record<string, string | number | boolean | Date | null | undefined>,
mode?: "reset" | "merge",
): BuildURI
Parameters
- val: Record<string, string | number | boolean | Date | null | undefined>
- mode: "reset" | "merge" = "reset"
Returns BuildURI
- Defined in uri.ts:422

delParam

delParam(key: string): BuildURI
Parameters
- key: string
Returns BuildURI
- Defined in uri.ts:430

defParam

defParam(key: string, str: string): BuildURI
Parameters
- key: string
- str: string
Returns BuildURI
- Defined in uri.ts:435

setParam

setParam(key: string, str: string): BuildURI
Parameters
- key: string
- str: string
Returns BuildURI
- Defined in uri.ts:442

hasParam

hasParam(key: string): boolean
Parameters
- key: string
Returns boolean
Implementation of URIInterface.hasParam
- Defined in uri.ts:447

getParam

getParam<T extends string | undefined>(
key: string | OneKey<string, string>,
def?: T,
): T extends string ? string : string | undefined
Type Parameters
- T extends string | undefined
Parameters
- key: string | OneKey<string, string>
- Optionaldef: T
Returns T extends string ? string : string | undefined
Implementation of URIInterface.getParam
- Defined in uri.ts:455

getParamResult

getParamResult(key: string, msgFn?: (key: string) => string): Result<string>
Parameters
- key: string
- OptionalmsgFn: (key: string) => string
Returns Result<string>
Implementation of URIInterface.getParamResult
- Defined in uri.ts:464

getParamsResult

getParamsResult(...keys: KeysParam): Result<Record<string, string>>
Parameters
- ...keys: KeysParam
Returns Result<Record<string, string>>
Implementation of URIInterface.getParamsResult
- Defined in uri.ts:468

getHashParams

getHashParams(...keys: KeysParam): Result<Record<string, string>>
Parameters
- ...keys: KeysParam
Returns Result<Record<string, string>>
- Defined in uri.ts:472

toString

toString(): string
Returns string
Implementation of URIInterface.toString
- Defined in uri.ts:476

toJSON

toJSON(): string
Returns string
Implementation of URIInterface.toJSON
- Defined in uri.ts:480

asURL

asURL(): URL
Returns URL
Implementation of URIInterface.asURL
- Defined in uri.ts:484

asObj

asObj(...strips: StripCommand[]): Partial<HostURIObject | PathURIObject>
Parameters
- ...strips: StripCommand[]
Returns Partial<HostURIObject | PathURIObject>
Implementation of URIInterface.asObj
- Defined in uri.ts:488

clone

clone(): BuildURI
Returns BuildURI
Implementation of URIInterface.clone
- Defined in uri.ts:492

URI

URI(): URI
Returns URI
- Defined in uri.ts:504

Class BuildURI

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Privateconstructor

Parameters

Returns BuildURI

Properties

_url

Accessors

getParams

Returns Iterable<[string, string]>

onlyHostAndSchema

Returns string

withoutHostAndSchema

Returns string

Methods

Staticis

Parameters

Returns value is BuildURI

Staticfrom

Parameters

Returns BuildURI

match

Parameters

Returns MatchResult

port

Parameters

Returns BuildURI

hostname

Parameters

Returns BuildURI

protocol

Parameters

Returns BuildURI

pathname

Parameters

Returns BuildURI

hash

Parameters

Returns BuildURI

resolve

Parameters

Returns BuildURI

appendRelative

Parameters

Returns BuildURI

cleanParams

Parameters

Returns BuildURI

searchParams

Parameters

Returns BuildURI

hashParams

Parameters

Returns BuildURI

delParam

Parameters

Returns BuildURI

defParam

Parameters

Returns BuildURI

setParam

Parameters

Returns BuildURI

hasParam

Parameters

Returns boolean

getParam

Type Parameters

Parameters

Returns T extends string ? string : string | undefined

getParamResult

Parameters

Returns Result<string>

`Private`constructor

`Static`is

`Static`from