summaryrefslogtreecommitdiff
path: root/doc/api/url.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-02 04:44:32 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-04 12:30:36 +0300
commit237cbe10fb82ba6ec69b14193a4a970e184306e7 (patch)
tree8fbbac215e1f9afcac524404e766c4157d8da145 /doc/api/url.md
parentf7049a20068dc8a7e904b7cdd3d5b307b595dd3a (diff)
downloadandroid-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.tar.gz
android-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.tar.bz2
android-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.zip
doc,tools: formalize, unify, codify default values
PR-URL: https://github.com/nodejs/node/pull/19737 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/url.md')
-rw-r--r--doc/api/url.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/url.md b/doc/api/url.md
index 2c12e9ac29..46b3a40f94 100644
--- a/doc/api/url.md
+++ b/doc/api/url.md
@@ -793,14 +793,14 @@ added: v7.6.0
* `URL` {URL} A [WHATWG URL][] object
* `options` {Object}
* `auth` {boolean} `true` if the serialized URL string should include the
- username and password, `false` otherwise. Defaults to `true`.
+ username and password, `false` otherwise. **Default:** `true`.
* `fragment` {boolean} `true` if the serialized URL string should include the
- fragment, `false` otherwise. Defaults to `true`.
+ fragment, `false` otherwise. **Default:** `true`.
* `search` {boolean} `true` if the serialized URL string should include the
- search query, `false` otherwise. Defaults to `true`.
+ search query, `false` otherwise. **Default:** `true`.
* `unicode` {boolean} `true` if Unicode characters appearing in the host
component of the URL string should be encoded directly as opposed to being
- Punycode encoded. Defaults to `false`.
+ Punycode encoded. **Default:** `false`.
Returns a customizable serialization of a URL String representation of a
[WHATWG URL][] object.
@@ -1032,12 +1032,12 @@ changes:
* `parseQueryString` {boolean} If `true`, the `query` property will always
be set to an object returned by the [`querystring`][] module's `parse()`
method. If `false`, the `query` property on the returned URL object will be an
- unparsed, undecoded string. Defaults to `false`.
+ unparsed, undecoded string. **Default:** `false`.
* `slashesDenoteHost` {boolean} If `true`, the first token after the literal
string `//` and preceding the next `/` will be interpreted as the `host`.
For instance, given `//foo/bar`, the result would be
`{host: 'foo', pathname: '/bar'}` rather than `{pathname: '//foo/bar'}`.
- Defaults to `false`.
+ **Default:** `false`.
The `url.parse()` method takes a URL string, parses it, and returns a URL
object.