-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
doc: discuss special protocol handling #22261
Closed
Closed
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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 |
---|---|---|
|
@@ -389,6 +389,46 @@ console.log(myURL.href); | |
|
||
Invalid URL protocol values assigned to the `protocol` property are ignored. | ||
|
||
##### Special Schemes | ||
|
||
The WHATWG URL Standard considers a handful of URL protocol schemes to be | ||
"special" in terms of how those are parsed and serialized. When a URL is | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
parsed using one of these special protocols, the `url.protocol` property | ||
may be changed to another special protocol but cannot be changed to a | ||
non-special protocol, and vice versa. | ||
|
||
For instance, changing from `http` to `https` works: | ||
|
||
```js | ||
const u = new URL('http://example.org'); | ||
u.protocol = 'https'; | ||
console.log(u.href); | ||
// https://example.org | ||
``` | ||
|
||
However, changing from `http` to a hypothetical `fish` protocol does not | ||
because the new protocol is not considered "special". | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
```js | ||
const u = new URL('http://example.org'); | ||
u.protocol = 'fish'; | ||
console.log(u.href); | ||
// http://example.org | ||
``` | ||
|
||
Likewise, changing from a non-special protocol to a special protocol is also | ||
not permitted: | ||
|
||
```js | ||
const u = new URL('fish://example.org'); | ||
u.protocol = 'http'; | ||
console.log(u.href); | ||
// fish://example.org | ||
``` | ||
|
||
The protocol schemes considered to be special by the WHATWG URL Standard | ||
include: `ftp`, `file`, `gopher`, `http`, `https`, `ws`, and `wss`. | ||
|
||
#### url.search | ||
|
||
* {string} | ||
|
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.
Linking the text
WHATWG URL Standard
to the standard itself would be useful here. It's already linked in two other places in the doc, so it's just a matter of changing the markdown to[WHATWG URL Standard][]
.