@types/url-parse

What is @types/url-parse?

@types/url-parse provides TypeScript type definitions for the url-parse library, which is used to parse, manipulate, and build URLs in JavaScript.

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

Parsing URLs

This feature allows you to parse a URL into its components such as protocol, hostname, port, pathname, query, and hash.

const URLParse = require('url-parse');
const url = new URLParse('https://example.com:8080/pathname/?search=test#hash');
console.log(url.protocol); // 'https:'
console.log(url.hostname); // 'example.com'
console.log(url.port); // '8080'
console.log(url.pathname); // '/pathname/'
console.log(url.query); // '?search=test'
console.log(url.hash); // '#hash'

Modifying URLs

This feature allows you to modify different parts of a URL and then convert it back to a string.

const URLParse = require('url-parse');
let url = new URLParse('https://example.com/pathname/?search=test#hash');
url.set('protocol', 'http');
url.set('hostname', 'example.org');
url.set('port', '3000');
console.log(url.toString()); // 'http://example.org:3000/pathname/?search=test#hash'

Query String Parsing

This feature allows you to parse the query string into an object for easier manipulation.

const URLParse = require('url-parse');
const url = new URLParse('https://example.com/pathname/?search=test&foo=bar', true);
console.log(url.query); // { search: 'test', foo: 'bar' }

Building URLs

This feature allows you to build a URL by setting its different components and then converting it back to a string.

const URLParse = require('url-parse');
const url = new URLParse('https://example.com');
url.set('pathname', '/newpath');
url.set('query', { search: 'newtest', foo: 'newbar' });
console.log(url.toString()); // 'https://example.com/newpath?search=newtest&foo=newbar'

Other packages similar to @types/url-parse

url

The 'url' package is a core Node.js module that provides utilities for URL resolution and parsing. It is similar to url-parse but is built into Node.js and may not have as many features for URL manipulation.

query-string

The 'query-string' package focuses on parsing and stringifying URL query strings. It provides a more specialized set of functionalities compared to url-parse, which handles the entire URL.

whatwg-url

The 'whatwg-url' package is a full implementation of the WHATWG URL Standard. It provides a more standards-compliant way to parse and manipulate URLs compared to url-parse.

README

Installation

npm install --save @types/url-parse

Summary

This package contains type definitions for url-parse (https://github.com/unshiftio/url-parse).

Details

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

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Hari Sivaramakrishnan, Dmitry Dushkin, David Golightly, and Kit Song.