Function buildUrl

buildUrl(
    override:
        | string
        | Readonly<
            PartialWithUndefined<
                {
                    hash?: string;
                    hostname?: string;
                    password?: string;
                    pathname?: string;
                    paths?: readonly string[];
                    port?: string
                    | number;
                    protocol?: string;
                    search?: string | Readonly<SearchParamsInput>;
                    username?: string;
                },
            >,
        >
        | URL,
    options?: Readonly<
        {
            encoding?: Encode
            | Decode
            | None;
            searchParamStrategy?: Clear | Replace | Append;
        },
    >,
): Readonly

import {buildUrl} from 'url-vir';

buildUrl({
    hostname: 'example.com',
    search: {
        hello: 'there',
    },
});

buildUrl.href; // `'example.com/?hello=there'`
Copy

buildUrl(
    baseUrl:
        | string
        | URL
        | Readonly<
            Readonly<
                {
                    fullPath: string;
                    hash: string;
                    host: string;
                    hostname: string;
                    href: string;
                    origin: string;
                    password: string;
                    pathname: string;
                    paths: readonly string[];
                    port: string;
                    protocol: string;
                    search: string;
                    searchParams: Readonly<Record<string, readonly string[]>>;
                    username: string;
                },
            >,
        >,
    override:
        | string
        | Readonly<
            PartialWithUndefined<
                {
                    hash?: string;
                    hostname?: string;
                    password?: string;
                    pathname?: string;
                    paths?: readonly string[];
                    port?: string
                    | number;
                    protocol?: string;
                    search?: string | Readonly<SearchParamsInput>;
                    username?: string;
                },
            >,
        >
        | URL,
    options?: Readonly<
        {
            encoding?: Encode
            | Decode
            | None;
            searchParamStrategy?: Clear | Replace | Append;
        },
    >,
): Readonly

import {buildUrl} from 'url-vir';

buildUrl('github.com/?hello=there', {
    hostname: 'example.com',
});

buildUrl.href; // `'example.com/?hello=there'`
Copy