@types/whatwg-url

What is @types/whatwg-url?

@types/whatwg-url provides TypeScript type definitions for the whatwg-url package, which is a JavaScript implementation of the URL Standard. This package allows developers to parse, serialize, and manipulate URLs in a way that is compliant with the WHATWG URL Standard.

What are @types/whatwg-url's main functionalities?

URL Parsing

This feature allows you to parse a URL string into a URL object, which provides properties and methods to access different parts of the URL.

const { URL } = require('whatwg-url');
const myURL = new URL('https://example.com/path?name=value#hash');
console.log(myURL.hostname); // 'example.com'

URL Serialization

This feature allows you to serialize a URL object back into a string, which can be useful for generating URLs dynamically.

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

URL Manipulation

This feature allows you to manipulate different parts of the URL, such as the pathname, search parameters, and hash.

const { URL } = require('whatwg-url');
const myURL = new URL('https://example.com/path?name=value#hash');
myURL.pathname = '/newpath';
console.log(myURL.href); // 'https://example.com/newpath?name=value#hash'

Other packages similar to @types/whatwg-url

url

The 'url' package is a Node.js core module that provides utilities for URL resolution and parsing. It is not as compliant with the WHATWG URL Standard as whatwg-url, but it is widely used in Node.js applications.

url-parse

The 'url-parse' package is a lightweight URL parser that works in both Node.js and browser environments. It provides a similar API to whatwg-url but is not fully compliant with the WHATWG URL Standard.

query-string

The 'query-string' package focuses on parsing and stringifying URL query strings. While it does not provide full URL parsing and manipulation capabilities, it is useful for handling query parameters specifically.

README

Installation

npm install --save @types/whatwg-url

Summary

This package contains type definitions for whatwg-url (https://github.com/jsdom/whatwg-url#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/whatwg-url.

Additional Details

• Last updated: Tue, 12 Nov 2024 00:46:36 GMT
• Dependencies: @types/webidl-conversions

Credits

These definitions were written by Alexander Marks, ExE Boss, and BendingBender.