Robert Kowalski
c8110692a5
doc: add explanations for querystring
...
- add an article: `decode a non-utf8 string`
- explain default and fallback behaviour of `querystring.unescape`
PR-URL: https://github.com/joyent/node/pull/9259
Reviewed-by: Julien Gilli <julien.gilli@joyent.com>
2015-03-03 10:03:42 -05:00
h7lin
8fb711e06c
doc: fix default value of opts.decodeURIComponent
...
In the documentation for querystring.parse, the documentation mentions
that the default value for options.decodeURIComponent is the
decodeURIComponent function, but it's actually the querystring.unescape
function.
PR-URL: https://github.com/joyent/node/pull/9259
Reviewed-by: Julien Gilli <julien.gilli@joyent.com>
2015-03-03 10:03:42 -05:00
Chris Dickinson
cf0306cd71
doc: update stability index
...
This simplifies the stability index to 4 levels:
0 - deprecated
1 - experimental / feature-flagged
2 - stable
3 - locked
Domains has been downgraded to deprecated, assert has been
downgraded to stable. Timers and Module remain locked. All
other APIs are now stable.
PR-URL: https://github.com/iojs/io.js/pull/943
Fixes: https://github.com/iojs/io.js/issues/930
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com>
2015-02-27 14:23:01 -08:00
Trevor Norris
f2a78de6ec
doc: fix optional parameter parsing
...
The parameter parser specifically looked for the old bracket syntax.
This generated a lot of warnings when building the docs. Those warnings
have been fixed by changing the parsing logic.
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
2014-09-29 16:32:34 -07:00
Trevor Norris
51b6b6844e
doc: fix brackets for optional parameters
...
Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:
fs.write(fd, data[, position[, encoding]], callback)
This simply fixes all uses of bracket notation in documentation.
Signed-off-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Fedor Indutny <fedor@indutny.com>
2014-09-25 11:26:15 -07:00
fengmk2
4729202d1e
querystring: custom encode and decode
...
Not all querystring are utf-8 encoding, make querystring can be used
to encode / decode `non-utf8` encoding string if necessary.
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
2014-05-22 08:21:55 -07:00
isaacs
1d5b6f26fe
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
...
Conflicts:
ChangeLog
Makefile
deps/npm/AUTHORS
deps/npm/html/api/bin.html
deps/npm/html/api/bugs.html
deps/npm/html/api/commands.html
deps/npm/html/api/config.html
deps/npm/html/api/deprecate.html
deps/npm/html/api/docs.html
deps/npm/html/api/edit.html
deps/npm/html/api/explore.html
deps/npm/html/api/help-search.html
deps/npm/html/api/init.html
deps/npm/html/api/install.html
deps/npm/html/api/link.html
deps/npm/html/api/load.html
deps/npm/html/api/ls.html
deps/npm/html/api/npm.html
deps/npm/html/api/outdated.html
deps/npm/html/api/owner.html
deps/npm/html/api/pack.html
deps/npm/html/api/prefix.html
deps/npm/html/api/prune.html
deps/npm/html/api/publish.html
deps/npm/html/api/rebuild.html
deps/npm/html/api/restart.html
deps/npm/html/api/root.html
deps/npm/html/api/run-script.html
deps/npm/html/api/search.html
deps/npm/html/api/shrinkwrap.html
deps/npm/html/api/start.html
deps/npm/html/api/stop.html
deps/npm/html/api/submodule.html
deps/npm/html/api/tag.html
deps/npm/html/api/test.html
deps/npm/html/api/uninstall.html
deps/npm/html/api/unpublish.html
deps/npm/html/api/update.html
deps/npm/html/api/version.html
deps/npm/html/api/view.html
deps/npm/html/api/whoami.html
deps/npm/html/doc/README.html
deps/npm/html/doc/adduser.html
deps/npm/html/doc/bin.html
deps/npm/html/doc/bugs.html
deps/npm/html/doc/build.html
deps/npm/html/doc/bundle.html
deps/npm/html/doc/cache.html
deps/npm/html/doc/changelog.html
deps/npm/html/doc/coding-style.html
deps/npm/html/doc/completion.html
deps/npm/html/doc/config.html
deps/npm/html/doc/deprecate.html
deps/npm/html/doc/developers.html
deps/npm/html/doc/disputes.html
deps/npm/html/doc/docs.html
deps/npm/html/doc/edit.html
deps/npm/html/doc/explore.html
deps/npm/html/doc/faq.html
deps/npm/html/doc/folders.html
deps/npm/html/doc/help-search.html
deps/npm/html/doc/help.html
deps/npm/html/doc/index.html
deps/npm/html/doc/init.html
deps/npm/html/doc/install.html
deps/npm/html/doc/json.html
deps/npm/html/doc/link.html
deps/npm/html/doc/list.html
deps/npm/html/doc/npm.html
deps/npm/html/doc/outdated.html
deps/npm/html/doc/owner.html
deps/npm/html/doc/pack.html
deps/npm/html/doc/prefix.html
deps/npm/html/doc/prune.html
deps/npm/html/doc/publish.html
deps/npm/html/doc/rebuild.html
deps/npm/html/doc/registry.html
deps/npm/html/doc/removing-npm.html
deps/npm/html/doc/restart.html
deps/npm/html/doc/root.html
deps/npm/html/doc/run-script.html
deps/npm/html/doc/scripts.html
deps/npm/html/doc/search.html
deps/npm/html/doc/semver.html
deps/npm/html/doc/shrinkwrap.html
deps/npm/html/doc/star.html
deps/npm/html/doc/start.html
deps/npm/html/doc/stop.html
deps/npm/html/doc/submodule.html
deps/npm/html/doc/tag.html
deps/npm/html/doc/test.html
deps/npm/html/doc/uninstall.html
deps/npm/html/doc/unpublish.html
deps/npm/html/doc/update.html
deps/npm/html/doc/version.html
deps/npm/html/doc/view.html
deps/npm/html/doc/whoami.html
deps/npm/lib/install.js
deps/npm/lib/ls.js
deps/npm/man/man1/npm.1
deps/npm/man/man1/shrinkwrap.1
deps/npm/man/man3/npm.3
deps/npm/man/man3/shrinkwrap.3
deps/npm/node_modules/request/main.js
deps/npm/node_modules/request/package.json
deps/npm/package.json
deps/uv/src/unix/core.c
deps/v8/src/conversions-inl.h
deps/v8/src/elements.cc
deps/v8/src/version.cc
doc/about/index.html
doc/api/assert.markdown
doc/api/child_process.markdown
doc/api/cluster.markdown
doc/api/crypto.markdown
doc/api/debugger.markdown
doc/api/dgram.markdown
doc/api/dns.markdown
doc/api/documentation.markdown
doc/api/events.markdown
doc/api/fs.markdown
doc/api/globals.markdown
doc/api/http.markdown
doc/api/https.markdown
doc/api/modules.markdown
doc/api/net.markdown
doc/api/os.markdown
doc/api/path.markdown
doc/api/process.markdown
doc/api/querystring.markdown
doc/api/readline.markdown
doc/api/stdio.markdown
doc/api/stream.markdown
doc/api/timers.markdown
doc/api/tls.markdown
doc/api/tty.markdown
doc/api/url.markdown
doc/api/util.markdown
doc/api/vm.markdown
doc/api/zlib.markdown
doc/api_assets/style.css
doc/community/index.html
doc/index.html
doc/logos/index.html
doc/template.html
src/node_version.h
tools/doc/html.js
tools/gyp/test/mac/app-bundle/empty.c
2012-03-03 23:38:52 -08:00
isaacs
2d44dcc8be
doc: Add stability indicators to documentation
2012-03-03 17:03:52 -08:00
isaacs
798f8a0dc1
doc refactor: querystring
2012-02-29 16:04:53 -08:00
isaacs
628bc835ae
doc refactor: querystring
2012-02-27 11:14:35 -08:00
Fedor Indutny
8a98c2f1d8
http, querystring: added limits to prevent DoS
2012-01-16 02:45:05 +06:00
koichik
e1c043f43a
docs: fix docs to not suggest variable leaks
...
Fixes #2106 .
2011-12-27 17:43:58 +09:00
AJ ONeal
8039086470
docs: document querystring behavior for arrays and unassigned parameters
2011-08-30 15:17:05 +02:00
Oleg Efimov
8b980d729c
Fix line wrapping in docs. Add tics for constants in docs text.
2010-11-18 15:41:15 -08:00
Ryan Dahl
bce092aeb8
Remove leading comma examples
2010-11-17 18:25:14 -08:00
Micheil Smith
e190c9616e
Splitting documentation
2010-10-28 14:59:15 -07:00
