kinetex - v1.0.0-rc.1
    Preparing search index...

    Class URLBuilder

    Immutable URL builder with a fluent API. Every method returns a new instance.

    Index

    Constructors

    • Parameters

      • url: string | URL

        Initial URL string or URL object.

      • Optionalbase: string | URL

        Optional base URL for resolving relative URLs.

      Returns URLBuilder

      If the URL is invalid.

    Accessors

    • get href(): string

      Full URL string.

      Returns string

    • get protocol(): string

      Protocol with trailing colon (e.g. "https:").

      Returns string

    • get hostname(): string

      Hostname (lowercased, IPv6 without brackets).

      Returns string

    • get host(): string

      Host (hostname + :port).

      Returns string

    • get port(): string

      Port string (empty for default port).

      Returns string

    • get pathname(): string

      Pathname component.

      Returns string

    • get search(): string

      Search string with leading "?".

      Returns string

    • get hash(): string

      Hash fragment with leading "#".

      Returns string

    • get origin(): string

      Read-only origin string.

      Returns string

    • get searchParams(): URLSearchParams

      Live URLSearchParams (cloned from internal state).

      Returns URLSearchParams

    • get queryObject(): Record<string, string | string[]>

      Parsed query as a plain object.

      Returns Record<string, string | string[]>

    Methods

    • Create a URLBuilder from a URL string or object (convenience factory).

      Parameters

      • url: string | URL
      • Optionalbase: string | URL

      Returns URLBuilder

    • Fill :param placeholders in pathname and add query params.

      Parameters

      • values: Record<string, string | number>

      Returns URLBuilder

    • Append a query parameter (allows repeated keys).

      Parameters

      • key: string
      • value: QueryValue

      Returns URLBuilder

    • Redact sensitive query params (replace value with "REDACTED").

      Parameters

      • ...keys: string[]

      Returns URLBuilder

    • Serialize to a URL string.

      Returns string

    • Clone as a native URL object.

      Returns URL