url-parse-lax

What is url-parse-lax?

The url-parse-lax package is designed to simplify the parsing of URLs with a more lenient approach to validation, making it easier to work with a wide range of URLs that might not strictly adhere to the standard formats. It builds upon the native URL parsing capabilities of Node.js, providing a more forgiving parsing process that can be particularly useful when dealing with user-generated or imperfect URLs.

What are url-parse-lax's main functionalities?

Parsing URLs with leniency

This feature allows for the parsing of URLs without requiring a protocol. It automatically prepends 'http://' to URLs that omit the protocol, making it easier to work with URLs provided in various formats.

const urlParseLax = require('url-parse-lax');
const parsedUrl = urlParseLax('www.example.com');
console.log(parsedUrl);

Extracting URL components

Beyond just lenient parsing, url-parse-lax also allows for easy extraction of different components of the URL, such as the pathname, search query, and hash fragment. This can be particularly useful for routing or processing specific parts of a URL.

const urlParseLax = require('url-parse-lax');
const parsedUrl = urlParseLax('http://www.example.com/path?query=123#fragment');
console.log(parsedUrl.pathname);
console.log(parsedUrl.search);
console.log(parsedUrl.hash);

Other packages similar to url-parse-lax

url-parse

url-parse is a robust URL parsing library that offers detailed parsing of URLs into components. It provides a similar level of functionality to url-parse-lax but with a focus on strict compliance with URL standards. Unlike url-parse-lax, it does not automatically prepend 'http://' to protocol-less URLs.

whatwg-url

whatwg-url is an implementation of the URL standard as specified by the WHATWG (Web Hypertext Application Technology Working Group). It offers comprehensive parsing and serialization of URLs. Compared to url-parse-lax, whatwg-url adheres strictly to the standard and is less forgiving of non-standard URLs.

README

url-parse-lax

Lax url.parse() with support for protocol-less URLs & IPs

Install

$ npm install url-parse-lax

Usage

import urlParseLax from 'url-parse-lax';

urlParseLax('sindresorhus.com');
/*
{
	protocol: 'https:',
	slashes: true,
	auth: null,
	host: 'sindresorhus.com',
	port: null,
	hostname: 'sindresorhus.com',
	hash: null,
	search: null,
	query: null,
	pathname: '/',
	path: '/',
	href: 'https://sindresorhus.com/'
}
*/

urlParseLax('[2001:db8::]:8000');
/*
{
	protocol: null,
	slashes: true,
	auth: null,
	host: '[2001:db8::]:8000',
	port: '8000',
	hostname: '2001:db8::',
	hash: null,
	search: null,
	query: null,
	pathname: '/',
	path: '/',
	href: 'http://[2001:db8::]:8000/'
}
*/

And with the built-in url.parse():

import url from 'url';

url.parse('sindresorhus.com');
/*
{
	protocol: null,
	slashes: null,
	auth: null,
	host: null,
	port: null,
	hostname: null,
	hash: null,
	search: null,
	query: null,
	pathname: 'sindresorhus',
	path: 'sindresorhus',
	href: 'sindresorhus'
}
*/

url.parse('[2001:db8::]:8000');
/*
{
	protocol: null,
	slashes: null,
	auth: null,
	host: null,
	port: null,
	hostname: null,
	hash: null,
	search: null,
	query: null,
	pathname: '[2001:db8::]:8000',
	path: '[2001:db8::]:8000',
	href: '[2001:db8::]:8000'
}
*/

API

urlParseLax(url, options?)

url

Type: string

The URL to parse.

options

Type: object

https

Type: boolean
Default: true

Prepend https:// instead of http:// to protocol-less URLs.

Related

• url-format-lax - Lax url.format() that formats a hostname and port into IPv6-compatible socket form of hostname:port

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}