Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add added: information for url, querystring #6593

Closed
wants to merge 2 commits into from
Closed

doc: add added: information for url, querystring #6593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae4ebbc
doc: add `added:` information for querystring
bengl May 5, 2016
876d11e
doc: add `added:` information for url
bengl May 5, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/api/querystring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,17 @@ This module provides utilities for dealing with query strings.
It provides the following methods:

## querystring.escape
<!-- YAML
added: v0.1.25
-->

The escape function used by `querystring.stringify`,
provided so that it could be overridden if necessary.

## querystring.parse(str[, sep][, eq][, options])
<!-- YAML
added: v0.1.25
-->

Deserialize a query string to an object.
Optionally override the default separator (`'&'`) and assignment (`'='`)
Expand All @@ -38,6 +44,9 @@ querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
```

## querystring.stringify(obj[, sep][, eq][, options])
<!-- YAML
added: v0.1.25
-->

Serialize an object to a query string.
Optionally override the default separator (`'&'`) and assignment (`'='`)
Expand All @@ -63,6 +72,9 @@ querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
```

## querystring.unescape
<!-- YAML
added: v0.1.25
-->

The unescape function used by `querystring.parse`,
provided so that it could be overridden if necessary.
Expand Down
9 changes: 9 additions & 0 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ properties of URL objects:
The following methods are provided by the URL module:

## url.format(urlObj)
<!-- YAML
added: v0.1.25
-->

Take a parsed URL object, and return a formatted URL string.

Expand All @@ -106,6 +109,9 @@ Here's how the formatting process works:
* `hash` is treated the same with or without the leading `#` (pound sign, anchor).

## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])
<!-- YAML
added: v0.1.25
-->

Take a URL string, and return an object.

Expand All @@ -120,6 +126,9 @@ Pass `true` as the third argument to treat `//foo/bar` as
`{ pathname: '//foo/bar' }`. Defaults to `false`.

## url.resolve(from, to)
<!-- YAML
added: v0.1.25
-->

Take a base URL, and a href URL, and resolve them as a browser would for
an anchor tag. Examples:
Expand Down