doc, url: various improvements to WHATWG API #11330
Closed
Conversation
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
TimothyGu
added
doc
jasnell
approved these changes
Feb 13, 2017
joyeecheung
reviewed
Feb 13, 2017
doc/api/url.md
Outdated
|
|
||
| #### urlSearchParams.toString() | ||
|
|
||
| * Returns: {String} | ||
|
|
||
| Returns the search parameters serialized as a URL-encoded string. | ||
| Returns the search parameters serialized as a percent-encoded string. |
There was a problem hiding this comment.
Probably "as percent-encoded strings" or "as a string of percent-encoded characters", or even "percent-encoded bytes"? "a percent-encoded string" sounds a bit weird given that they would be not just be encoded but also joined with & and =s.
Another way to explain it would be to mention that it is somewhat similar to querystring.stringify().
There was a problem hiding this comment.
How about:
-Returns the search parameters serialized as a URL-encoded string.
+Returns the search parameters serialized as a string, with characters
+percent-encoded where necessary.
doc/api/url.md
Outdated
| value returned is equivalent to that of [`url.href`][]. | ||
|
|
||
| Because of the need for standard compliance, this method does not allow for | ||
| customization on the serialization process of the URL. For more flexibility, |
There was a problem hiding this comment.
nit: "does not allow users to customize the.." seems easier to read?
doc/api/url.md
Outdated
| @@ -298,6 +298,35 @@ forward slash (`/`) character is encoded as `%3C`. | |||
| The `url` module provides an *experimental* implementation of the | |||
| [WHATWG URL Standard][] as an alternative to the existing `url.parse()` API. | |||
|
|
|||
| A comparison between this API and `url.parse()` is given below. Above the URL | |||
| `'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'`, properties of an | |||
| object returned by `url.parse()` are given. Beneath it are properties of a | |||
There was a problem hiding this comment.
nit: "Below it"?(as opposed to "Above it")
| which characters to percent-encode may vary somewhat from what the | ||
| [`url.parse()`][] and [`url.format()`][] methods would produce. | ||
| are [percent-encoded][]. Note that the selection of which characters to | ||
| percent-encode may vary somewhat from what the [`url.parse()`][] and |
There was a problem hiding this comment.
I know it's already there but technically, doesn't url.parse() percent-decode things..?
There was a problem hiding this comment.
url.parse() also encodes certain things:
> url.parse('http://\n.com').pathname
'%0A.com'
TimothyGu
force-pushed
the
url-components-doc
branch
from
7a14576 to
424ec4f
Compare
joyeecheung
approved these changes
Feb 15, 2017
TimothyGu
added a commit
that referenced
this pull request
Feb 16, 2017
PR-URL: #11330 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
TimothyGu
added a commit
to TimothyGu/node
that referenced
this pull request
Feb 18, 2017
TimothyGu
added a commit
to TimothyGu/node
that referenced
this pull request
Feb 18, 2017
Also remove executable bit from doc/api/url.md's mode. Backport-of: nodejs#11330 Fixes: 84e2ff3 "doc: add basic documentation for WHATWG URL API"
4 tasks
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 20, 2017
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 20, 2017
Also remove executable bit from doc/api/url.md's mode. Backport-of: nodejs#11330 Fixes: 84e2ff3 "doc: add basic documentation for WHATWG URL API"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist
Affected core subsystem(s)
doc, url