@automattic/calypso-url
Version:
This library provides both generic and Calypso-specific utilities for handling URLs.
42 lines • 994 B
TypeScript
interface UrlParts {
protocol: string;
host: string;
hostname: string;
port: string;
origin: string;
pathname: string;
hash: string;
search: string;
searchParams: URLSearchParams;
username: string;
password: string;
}
interface OptionalUrlParts {
protocol?: string;
host?: string;
hostname?: string;
port?: string;
origin?: string;
pathname?: string;
hash?: string;
search?: string;
searchParams?: URLSearchParams;
username?: string;
password?: string;
}
/**
* Returns the various available URL parts.
*
* @param url the URL to analyze
* @returns the URL parts
*/
export declare function getUrlParts(url: string | URL): UrlParts;
/**
* Returns a URL object built from the provided URL parts.
*
* @param parts the provided URL parts.
* @returns the generated URL object.
*/
export declare function getUrlFromParts(parts: OptionalUrlParts): URL;
export {};
//# sourceMappingURL=url-parts.d.ts.map