Skip to content

Commit

Permalink
doc: sort url alphabetically
Browse files Browse the repository at this point in the history
Reorders, with no contextual changes, the url documentation
alphabetically.

PR-URL: #3662
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
  • Loading branch information
tflanagan authored and rvagg committed Nov 13, 2015
1 parent 39b8259 commit d4dda77
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions doc/api/url.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit d4dda77

Please sign in to comment.