url-clean
Normalize a URL
Fork of normalize-url
Added extra test cases, fixed minor bugs and reduced dependency.
Useful when you need to display, store, deduplicate, sort, compare, etc, URLs.
Install
$ npm install url-clean
Usage
const clean = ; ;//=> 'http://sindresorhus.com' ;//=> 'http://êxample.com/?a=foo&b=bar'API
clean(url, [options])
url
Type: string
URL to normalize.
options
Type: Object
normalizeProtocol
Type: boolean
Default: true
Prepend http: to the URL if it's protocol-relative.
;//=> 'http://sindresorhus.com' ;//=> '//sindresorhus.com'normalizeHttps
Type: boolean
Default: false
Normalize https: URLs to http:.
;//=> 'https://sindresorhus.com' ;//=> 'http://sindresorhus.com'stripFragment
Type: boolean
Default: true
Remove the fragment at the end of the URL.
;//=> 'http://sindresorhus.com/about.html' ;//=> 'http://sindresorhus.com/about.html#contact'stripWWW
Type: boolean
Default: true
Remove www. from the URL.
;//=> 'http://sindresorhus.com/about.html#contact' ;//=> 'http://www.sindresorhus.com/about.html#contact'removeQueryParameters
Type: Array<RegExp|string>
Default: [/^utm_\w+/i]
Remove query parameters that matches any of the provided strings or regexes.
;//=> 'http://sindresorhus.com/?foo=bar'removeTrailingSlash
Type: boolean
Default: true
Remove trailing slash.
;//=> 'http://sindresorhus.com/redirect' ;//=> 'http://sindresorhus.com/redirect/' ;//=> 'http://sindresorhus.com/'removeDirectoryIndex
Type: boolean Array<RegExp|string>
Default: false
Remove the default directory index file from path that matches any of the provided strings or regexes. When true, the regex /^index\.[a-z]+$/ is used.
;//=> 'http://sindresorhus.com/foo'sortQueryParameters
Type: boolean
Default: true
Sort the query parameters alphabetically by key.
;//=> 'http://sindresorhus.com/?b=two&a=one&c=three'removeJSessionId
Type: boolean
Default: true
remove the Spring JSessionId
;//=> 'http://sindresorhus.com'