extract-from-url

Extracts parts of the url

Examples

Url with hostname

import extractFromUrl, { Url } from 'extract-from-url'

const url = 'https://www.subdomain.domain.com:80/path/123'

const urlParts: Url = extractFromUrl(url)
console.log(urlParts)
/*
{
  protocol: 'https',
  address: 'subdomain.domain.com',
  port: '80',
  ip: undefined,
  hostname: 'subdomain.domain.com',
  subdomain: 'subdomain',
  domain: 'domain.com',
  path: '/path/123',
  parameters: undefined,
}
*/

const { hostname } = extractFromUrl(url)
// Or: const hostname: string = extractFromUrl(url, 'hostname')
console.log(hostname)
// 'subdomain.domain.com'

Ip address url

import extractFromUrl, { Url } from 'extract-from-url'

const url = 'http://127.0.0.1:3000'

const urlParts: Url = extractFromUrl(url)
console.log(urlParts)
/*
{
  protocol: 'http',
  address: '127.0.0.1',
  port: '3000',
  ip: '127.0.0.1',
  hostname: undefined,
  subdomain: undefined,
  domain: undefined,
  path: undefined,
  parameters: undefined,
}
*/

const { ip, port } = extractFromUrl(url)
// Or: const ip: string = extractFromUrl(url, 'ip');
console.log(ip) // '127.0.0.1'
console.log(port) // '3000'

Url parameters (new in v2.1)

import extractFromUrl, { Url } from 'extract-from-url'

const url = 'http://www.example.com:80/path/to/api?key1=value1&key2=value2'

const urlParts: Url = extractFromUrl(url)
console.log(urlParts)
/*
{
  protocol: 'http',
  address: 'www.example.com',
  port: '80',
  ip: undefined,
  hostname: 'www.example.com',
  subdomain: 'www',
  domain: 'example.com',
  path: '/path/to/api',
  parameters: [
    { key: 'key1', value: 'value1' },
    { key: 'key2', value: 'value2' }
  ]
}
*/

Use the second parameter to extract a specific part of the url

import extractFromUrl from 'extract-from-url'

const url = 'http://www.example.com:80/path/to/api?key1=value1&key2=value2'

const domain: string = extractFromUrl(url, 'hostname')
console.log(domain)
// example.com

Other considerations

This function is not performance-oriented.

Breaking changes

v1.3

• The return type of the function change to Url or string depending on passing or not the second parameter

v2.0

• Targeting to ES6

v2.1

• After add parameters extraction, the path do not include everything anymore. Example:

// URL: http://www.example.com:80/path/to/api?key1=value1&key2=value2
// path before v2.1:
{
  path: '/path/to/api?key1=value1&key2=value2'
}

// path in v2.1:
{
  path: '/path/to/api'
}

v3.0

• Targeting to es2018

• Change what is considered a subdomain. Example:

// URL: http://www.example.com:80/path/to/api?key1=value1&key2=value2
// subdomain before v3.0:
{
  subdomain: undefined
}

// subdomain in v3.0:
{
  subdomain: 'www'
}

• Fix the issue with domain when in the TLD has a second level. Example:

// URL: http://www.example.co.uk:80/path/to/api?key1=value1&key2=value2
// domain before v3.0:
{
  domain: 'co.uk'
}

// domain in v3.0:
{
  domain: 'example.co.uk'
}

TODO

• [x] Extract parameters from URL ("http://www.example.com:80/path/to/api?key1=value1&key2=value2")
• [ ] Extract #hashtags redirect from URL ("http://www.example.com:80/page#SomewhereInTheDocument", "https://github.com:32199/users/iggy#foo?bar=baz#qux")