diff options
| author | Rahat Ahmed <rahatarmanahmed@gmail.com> | 2016-11-15 13:56:03 -0600 |
|---|---|---|
| committer | Michaël Zasso <targos@protonmail.com> | 2016-11-19 18:16:48 +0100 |
| commit | 8f05611a5c2c552e7001f77c6ae6a4fd166f7fdd (patch) | |
| tree | 1c457f8660d3d14912d9816e21696c6d7b8993c7 /doc/api/url.md | |
| parent | 45279947f1570653ad8be57792d4a2232a11e454 (diff) | |
| download | android-node-v8-8f05611a5c2c552e7001f77c6ae6a4fd166f7fdd.tar.gz android-node-v8-8f05611a5c2c552e7001f77c6ae6a4fd166f7fdd.tar.bz2 android-node-v8-8f05611a5c2c552e7001f77c6ae6a4fd166f7fdd.zip | |
doc: improve description of urlObject.query
The description of urlObject.query is ambiguous about when it's an
object vs when it's a string. Added a sentence pointing to the option
that determines this in url.parse().
Also fixed the missing parentheses in the first sentence by rewording it to
avoid nested parentheses.
PR-URL: https://github.com/nodejs/node/pull/9625
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Diffstat (limited to 'doc/api/url.md')
| -rw-r--r-- | doc/api/url.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/api/url.md b/doc/api/url.md index 522c5396d9..6d573b4b91 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -114,9 +114,10 @@ No decoding of the `path` is performed. ### urlObject.query -The `query` property is either the "params" portion of the query string ( -everything *except* the leading ASCII question mark (`?`), or an object -returned by the [`querystring`][] module's `parse()` method: +The `query` property is either the query string without the leading ASCII +question mark (`?`), or an object returned by the [`querystring`][] module's +`parse()` method. Whether the `query` property is a string or object is +determined by the `parseQueryString` argument passed to `url.parse()`. For example: `'query=string'` or `{'query': 'string'}` |