Browse Source

doc: sort url alphabetically

Reorders, with no contextual changes, the url documentation
alphabetically.

PR-URL: https://github.com/nodejs/node/pull/3662
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
process-exit-stdio-flushing
Tristian Flanagan 9 years ago
committed by James M Snell
parent
commit
32d0d67700
  1. 28
      doc/api/url.markdown

28
doc/api/url.markdown

@ -77,20 +77,6 @@ properties of URL objects:
The following methods are provided by the URL module:
## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])
Take a URL string, and return an object.
Pass `true` as the second argument to also parse the query string using the
`querystring` module. If `true` then the `query` property will always be
assigned an object, and the `search` property will always be a (possibly
empty) string. If `false` then the `query` property will not be parsed or
decoded. Defaults to `false`.
Pass `true` as the third argument to treat `//foo/bar` as
`{ host: 'foo', pathname: '/bar' }` rather than
`{ pathname: '//foo/bar' }`. Defaults to `false`.
## url.format(urlObj)
Take a parsed URL object, and return a formatted URL string.
@ -117,6 +103,20 @@ Here's how the formatting process works:
* It is treated the same with or without the leading `?` (question mark).
* `hash` is treated the same with or without the leading `#` (pound sign, anchor).
## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])
Take a URL string, and return an object.
Pass `true` as the second argument to also parse the query string using the
`querystring` module. If `true` then the `query` property will always be
assigned an object, and the `search` property will always be a (possibly
empty) string. If `false` then the `query` property will not be parsed or
decoded. Defaults to `false`.
Pass `true` as the third argument to treat `//foo/bar` as
`{ host: 'foo', pathname: '/bar' }` rather than
`{ pathname: '//foo/bar' }`. Defaults to `false`.
## url.resolve(from, to)
Take a base URL, and a href URL, and resolve them as a browser would for

Loading…
Cancel
Save