-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Include normalize-url directly in source
- Loading branch information
Showing
11 changed files
with
862 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ dist | |
generated-client | ||
lib | ||
node_modules | ||
src/utils/normalize-url |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,263 @@ | ||
export interface Options { | ||
/** | ||
@default 'http:' | ||
*/ | ||
readonly defaultProtocol?: string; | ||
|
||
/** | ||
Prepends `defaultProtocol` to the URL if it's protocol-relative. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('//sindresorhus.com:80/'); | ||
//=> 'http://sindresorhus.com' | ||
normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false}); | ||
//=> '//sindresorhus.com' | ||
``` | ||
*/ | ||
readonly normalizeProtocol?: boolean; | ||
|
||
/** | ||
Normalizes `https:` URLs to `http:`. | ||
@default false | ||
@example | ||
``` | ||
normalizeUrl('https://sindresorhus.com:80/'); | ||
//=> 'https://sindresorhus.com' | ||
normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true}); | ||
//=> 'http://sindresorhus.com' | ||
``` | ||
*/ | ||
readonly forceHttp?: boolean; | ||
|
||
/** | ||
Normalizes `http:` URLs to `https:`. | ||
This option can't be used with the `forceHttp` option at the same time. | ||
@default false | ||
@example | ||
``` | ||
normalizeUrl('https://sindresorhus.com:80/'); | ||
//=> 'https://sindresorhus.com' | ||
normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true}); | ||
//=> 'https://sindresorhus.com' | ||
``` | ||
*/ | ||
readonly forceHttps?: boolean; | ||
|
||
/** | ||
Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('user:[email protected]'); | ||
//=> 'https://sindresorhus.com' | ||
normalizeUrl('user:[email protected]', {stripAuthentication: false}); | ||
//=> 'https://user:[email protected]' | ||
``` | ||
*/ | ||
readonly stripAuthentication?: boolean; | ||
|
||
/** | ||
Removes hash from the URL. | ||
@default false | ||
@example | ||
``` | ||
normalizeUrl('sindresorhus.com/about.html#contact'); | ||
//=> 'http://sindresorhus.com/about.html#contact' | ||
normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true}); | ||
//=> 'http://sindresorhus.com/about.html' | ||
``` | ||
*/ | ||
readonly stripHash?: boolean; | ||
|
||
/** | ||
Removes HTTP(S) protocol from an URL `http://sindresorhus.com` → `sindresorhus.com`. | ||
@default false | ||
@example | ||
``` | ||
normalizeUrl('https://sindresorhus.com'); | ||
//=> 'https://sindresorhus.com' | ||
normalizeUrl('sindresorhus.com', {stripProtocol: true}); | ||
//=> 'sindresorhus.com' | ||
``` | ||
*/ | ||
readonly stripProtocol?: boolean; | ||
|
||
/** | ||
Strip the [text fragment](https://web.dev/text-fragments/) part of the URL | ||
__Note:__ The text fragment will always be removed if the `stripHash` option is set to `true`, as the hash contains the text fragment. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello'); | ||
//=> 'http://sindresorhus.com/about.html#' | ||
normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello'); | ||
//=> 'http://sindresorhus.com/about.html#section' | ||
normalizeUrl('http://sindresorhus.com/about.html#:~:text=hello', {stripTextFragment: false}); | ||
//=> 'http://sindresorhus.com/about.html#:~:text=hello' | ||
normalizeUrl('http://sindresorhus.com/about.html#section:~:text=hello', {stripTextFragment: false}); | ||
//=> 'http://sindresorhus.com/about.html#section:~:text=hello' | ||
``` | ||
*/ | ||
readonly stripTextFragment?: boolean; | ||
|
||
/** | ||
Removes `www.` from the URL. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('http://www.sindresorhus.com'); | ||
//=> 'http://sindresorhus.com' | ||
normalizeUrl('http://www.sindresorhus.com', {stripWWW: false}); | ||
//=> 'http://www.sindresorhus.com' | ||
``` | ||
*/ | ||
readonly stripWWW?: boolean; | ||
|
||
/** | ||
Removes query parameters that matches any of the provided strings or regexes. | ||
@default [/^utm_\w+/i] | ||
@example | ||
``` | ||
normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', { | ||
removeQueryParameters: ['ref'] | ||
}); | ||
//=> 'http://sindresorhus.com/?foo=bar' | ||
``` | ||
If a boolean is provided, `true` will remove all the query parameters. | ||
``` | ||
normalizeUrl('www.sindresorhus.com?foo=bar', { | ||
removeQueryParameters: true | ||
}); | ||
//=> 'http://sindresorhus.com' | ||
``` | ||
`false` will not remove any query parameter. | ||
``` | ||
normalizeUrl('www.sindresorhus.com?foo=bar&utm_medium=test&ref=test_ref', { | ||
removeQueryParameters: false | ||
}); | ||
//=> 'http://www.sindresorhus.com/?foo=bar&ref=test_ref&utm_medium=test' | ||
``` | ||
*/ | ||
readonly removeQueryParameters?: ReadonlyArray<RegExp | string> | boolean; | ||
|
||
/** | ||
Removes trailing slash. | ||
__Note__: Trailing slash is always removed if the URL doesn't have a pathname unless the `removeSingleSlash` option is set to `false`. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('http://sindresorhus.com/redirect/'); | ||
//=> 'http://sindresorhus.com/redirect' | ||
normalizeUrl('http://sindresorhus.com/redirect/', {removeTrailingSlash: false}); | ||
//=> 'http://sindresorhus.com/redirect/' | ||
normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false}); | ||
//=> 'http://sindresorhus.com' | ||
``` | ||
*/ | ||
readonly removeTrailingSlash?: boolean; | ||
|
||
/** | ||
Remove a sole `/` pathname in the output. This option is independant of `removeTrailingSlash`. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('https://sindresorhus.com/'); | ||
//=> 'https://sindresorhus.com' | ||
normalizeUrl('https://sindresorhus.com/', {removeSingleSlash: false}); | ||
//=> 'https://sindresorhus.com/' | ||
``` | ||
*/ | ||
readonly removeSingleSlash?: boolean; | ||
|
||
/** | ||
Removes 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. | ||
@default false | ||
@example | ||
``` | ||
normalizeUrl('www.sindresorhus.com/foo/default.php', { | ||
removeDirectoryIndex: [/^default\.[a-z]+$/] | ||
}); | ||
//=> 'http://sindresorhus.com/foo' | ||
``` | ||
*/ | ||
readonly removeDirectoryIndex?: boolean | ReadonlyArray<RegExp | string>; | ||
|
||
/** | ||
Sorts the query parameters alphabetically by key. | ||
@default true | ||
@example | ||
``` | ||
normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', { | ||
sortQueryParameters: false | ||
}); | ||
//=> 'http://sindresorhus.com/?b=two&a=one&c=three' | ||
``` | ||
*/ | ||
readonly sortQueryParameters?: boolean; | ||
} | ||
|
||
/** | ||
[Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL. | ||
@param url - URL to normalize, including [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs). | ||
@example | ||
``` | ||
import normalizeUrl from 'normalize-url'; | ||
normalizeUrl('sindresorhus.com'); | ||
//=> 'http://sindresorhus.com' | ||
normalizeUrl('//www.sindresorhus.com:80/../baz?b=bar&a=foo'); | ||
//=> 'http://sindresorhus.com/baz?a=foo&b=bar' | ||
``` | ||
*/ | ||
export default function normalizeUrl(url: string, options?: Options): string; |
Oops, something went wrong.