Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

url-parse-lax

sindresorhus22.9mMIT5.0.0TypeScript support: definitely-typed

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

url, parse, parser, loose, lax, protocol, less, protocol-less, ip, ipv4, ipv6

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.

  • 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.