1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: url.format - true slash postfix behaviour

Browse Source 
Change url.format's references to slash postfixing to reflect
true behaviour (it only automatically postfixes slashes to the
slashedProtocols when host is present).

Fixes: #3361

PR-URL: https://github.com/nodejs/node/pull/4119
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
This commit is contained in:
fansworld-claudio 2015-12-02 14:58:50 -03:00 committed by minwoojung
parent f8cf9474ce
commit 2a29b70b37
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/url.markdown
View File

@ -87,12 +87,12 @@ Here's how the formatting process works:
* `path` will be ignored. * `path` will be ignored.
* `protocol` is treated the same with or without the trailing `:` (colon). * `protocol` is treated the same with or without the trailing `:` (colon).
* The protocols `http`, `https`, `ftp`, `gopher`, `file` will be * The protocols `http`, `https`, `ftp`, `gopher`, `file` will be
postfixed with `://` (colon-slash-slash). postfixed with `://` (colon-slash-slash) as long as `host`/`hostname` are present.
* All other protocols `mailto`, `xmpp`, `aim`, `sftp`, `foo`, etc will * All other protocols `mailto`, `xmpp`, `aim`, `sftp`, `foo`, etc will
be postfixed with `:` (colon). be postfixed with `:` (colon).
* `slashes` set to `true` if the protocol requires `://` (colon-slash-slash) * `slashes` set to `true` if the protocol requires `://` (colon-slash-slash)
* Only needs to be set for protocols not previously listed as requiring * Only needs to be set for protocols not previously listed as requiring
slashes, such as `mongodb://localhost:8000/`. slashes, such as `mongodb://localhost:8000/`, or if `host`/`hostname` are absent.
* `auth` will be used if present. * `auth` will be used if present.
* `hostname` will only be used if `host` is absent. * `hostname` will only be used if `host` is absent.
* `port` will only be used if `host` is absent. * `port` will only be used if `host` is absent.