New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add TypeScript definition #88
Merged
sindresorhus
merged 2 commits into
sindresorhus:master
from
BendingBender:introduce-ts-types
Feb 28, 2019
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"bracketSpacing": false, | ||
"singleQuote": true | ||
} | ||
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,183 @@ | ||
export interface Options { | ||
/** | ||
* @default 'http:' | ||
*/ | ||
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' | ||
*/ | ||
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' | ||
*/ | ||
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' | ||
*/ | ||
forceHttps?: boolean; | ||
|
||
/** | ||
* Strip the [authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) part of a URL. | ||
* | ||
* @default true | ||
* | ||
* @example | ||
* | ||
* normalizeUrl('user:password@sindresorhus.com'); | ||
* //=> 'https://sindresorhus.com' | ||
* | ||
* normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false}); | ||
* //=> 'https://user:password@sindresorhus.com' | ||
*/ | ||
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' | ||
*/ | ||
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' | ||
*/ | ||
stripProtocol?: 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' | ||
*/ | ||
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' | ||
*/ | ||
removeQueryParameters?: (RegExp | string)[]; | ||
|
||
/** | ||
* Removes trailing slash. | ||
* | ||
* **Note**: Trailing slash is always removed if the URL doesn't have a pathname. | ||
* | ||
* @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' | ||
*/ | ||
removeTrailingSlash?: 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' | ||
*/ | ||
removeDirectoryIndex?: (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' | ||
*/ | ||
sortQueryParameters?: boolean; | ||
} | ||
|
||
/** | ||
* [Normalize](https://en.wikipedia.org/wiki/URL_normalization) a URL. | ||
* | ||
* @param url - URL to normalize. | ||
*/ | ||
export default function normalizeUrl(url: string, options?: Options): string; |
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,24 @@ | ||
import {expectType} from 'tsd-check'; | ||
import normalizeUrl from '.'; | ||
|
||
expectType<string>(normalizeUrl('sindresorhus.com')); | ||
expectType<string>(normalizeUrl('HTTP://xn--xample-hva.com:80/?b=bar&a=foo')); | ||
|
||
normalizeUrl('//sindresorhus.com:80/', {defaultProtocol: 'https:'}); | ||
normalizeUrl('//sindresorhus.com:80/', {normalizeProtocol: false}); | ||
normalizeUrl('https://sindresorhus.com:80/', {forceHttp: true}); | ||
normalizeUrl('http://sindresorhus.com:80/', {forceHttps: true}); | ||
normalizeUrl('user:password@sindresorhus.com', {stripAuthentication: false}); | ||
normalizeUrl('sindresorhus.com/about.html#contact', {stripHash: true}); | ||
normalizeUrl('https://sindresorhus.com', {stripProtocol: true}); | ||
normalizeUrl('http://www.sindresorhus.com', {stripWWW: false}); | ||
normalizeUrl('www.sindresorhus.com?foo=bar&ref=test_ref', { | ||
removeQueryParameters: ['ref', /test/] | ||
}); | ||
normalizeUrl('http://sindresorhus.com/', {removeTrailingSlash: false}); | ||
normalizeUrl('www.sindresorhus.com/foo/default.php', { | ||
removeDirectoryIndex: [/^default\.[a-z]+$/, 'foo'] | ||
}); | ||
normalizeUrl('www.sindresorhus.com?b=two&a=one&c=three', { | ||
sortQueryParameters: false | ||
}); |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should not be here. I don't use Prettier and shouldn't have to have boilerplate config to disable it either.