The whatwg-url npm package is an implementation of the URL and URLSearchParams interfaces found in the WHATWG URL Standard. It provides utilities for URL parsing, serialization, and manipulation in accordance with the standard.

What are whatwg-url's main functionalities?

Parsing and Serializing URLs

This feature allows for the parsing of a full URL string into its constituent parts, as well as the serialization of the URL object back into a string.

const { URL } = require('whatwg-url');
const myURL = new URL('https://example.com/path?query=123#fragment');
console.log(myURL.href); // 'https://example.com/path?query=123#fragment'

Manipulating URL Components

This feature enables the modification of different parts of the URL, such as the pathname, search, or hash.

const { URL } = require('whatwg-url');
const myURL = new URL('https://example.com/path');
myURL.pathname = '/newPath';
console.log(myURL.href); // 'https://example.com/newPath'

Working with URLSearchParams

This feature provides an interface for working with query strings, allowing for easy parsing, appending, deleting, and iterating over query parameters.

const { URLSearchParams } = require('whatwg-url');
const params = new URLSearchParams('key1=value1&key2=value2');
params.append('key3', 'value3');
console.log(params.toString()); // 'key1=value1&key2=value2&key3=value3'

Other packages similar to whatwg-url

Readme

Source

whatwg-url

whatwg-url is a full implementation of the WHATWG URL Standard. It can be used standalone, but it also exposes a lot of the internal algorithms that are useful for integrating a URL parser into a project like jsdom.

Current status

whatwg-url is currently up to date with the URL spec up to commit a62223.

API

The `URL` and `URLSearchParams` classes

The main API is provided by the URL and URLSearchParams exports, which follows the spec's behavior in all ways (including e.g. USVString conversion). Most consumers of this library will want to use these.

Low-level URL Standard API

The following methods are exported for use by places like jsdom that need to implement things like HTMLHyperlinkElementUtils. They mostly operate on or return an "internal URL" or "URL record" type.

URL parser: parseURL(input, { baseURL, encodingOverride })
Basic URL parser: basicURLParse(input, { baseURL, encodingOverride, url, stateOverride })
URL serializer: serializeURL(urlRecord, excludeFragment)
Host serializer: serializeHost(hostFromURLRecord)
Serialize an integer: serializeInteger(number)
Origin serializer: serializeURLOrigin(urlRecord)
Set the username: setTheUsername(urlRecord, usernameString)
Set the password: setThePassword(urlRecord, passwordString)
Cannot have a username/password/port: cannotHaveAUsernamePasswordPort(urlRecord)
Percent decode: percentDecode(buffer)

The stateOverride parameter is one of the following strings:

The URL record type has the following API:

These properties should be treated with care, as in general changing them will cause the URL record to be in an inconsistent state until the appropriate invocation of basicURLParse is used to fix it up. You can see examples of this in the URL Standard, where there are many step sequences like "4. Set context object’s url’s fragment to the empty string. 5. Basic URL parse input with context object’s url as url and fragment state as state override." In between those two steps, a URL record is in an unusable state.

The return value of "failure" in the spec is represented by null. That is, functions like parseURL and basicURLParse can return either a URL record or null.

FAQs

What is whatwg-url?

Is whatwg-url well maintained?

Last updated on 29 Jun 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install