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
Ben Noordhuis
28659aba37
Merge remote-tracking branch 'origin/v0.10'
...
Conflicts:
deps/uv/ChangeLog
deps/uv/src/unix/stream.c
deps/uv/src/version.c
lib/tls.js
2013-05-29 23:12:11 +02:00
Daniel G. Taylor
675e85813f
https: Add secureProtocol docs
...
Add `secureProtocol` parameter docs to the https.request method.
2013-05-28 21:43:37 +02:00
Ben Noordhuis
ab518e8831
https: implement https.Server#setTimeout()
...
Like commit d258fb0#5361 .
2013-04-30 13:10:56 +02:00
Yi EungJun
852444a720
doc: https: Fix the link to tls.connect
2013-03-16 23:52:39 +01:00
isaacs
77ed12fe7a
Merge remote-tracking branch 'ry/v0.8' into master
...
Conflicts:
AUTHORS
ChangeLog
deps/uv/test/test-spawn.c
deps/uv/uv.gyp
src/cares_wrap.cc
src/node.cc
src/node_version.h
test/simple/test-buffer.js
tools/gyp/pylib/gyp/common.py
tools/install.py
2012-12-13 16:57:58 -08:00
Ryunosuke SATO
83161455bd
doc: Fix missing link target to 'https.request()'
2012-11-27 18:11:40 -08:00
Francois Marier
44dd2c392a
doc: remove duplicate set of options
2012-10-30 01:20:17 +01:00
Francois Marier
326bce91d6
doc: reflect hostname v. host preference in examples
...
The documentation for http.request and https.request states that
`hostname` is preferred over `host` so the code examples should
use that option name.
2012-10-29 20:34:03 +01:00
Nathan Rajlich
4b238b4c2a
Merge remote-tracking branch 'origin/v0.8'
...
Conflicts:
AUTHORS
ChangeLog
deps/uv/test/runner-win.c
doc/api/process.markdown
lib/repl.js
src/node_crypto.cc
src/node_version.h
2012-10-13 16:16:56 -07:00
Andreas Madsen
be5a8e24c2
doc: consistent use of the callback argument
2012-10-08 22:58:11 +02:00
Ben Noordhuis
35607f3a2d
tls, https: validate server certificate by default
...
This commit changes the default value of the rejectUnauthorized option from
false to true.
What that means is that tls.connect(), https.get() and https.request() will
reject invalid server certificates from now on, including self-signed
certificates.
There is an escape hatch: if you set the NODE_TLS_REJECT_UNAUTHORIZED
environment variable to the literal string "0", node.js reverts to its
old behavior.
Fixes #3949 .
2012-09-15 00:19:06 +02:00
Nathan Rajlich
2d0c1da975
docs: fix syntax error in "https" example
2012-08-24 16:11:55 -07:00
koichik
752ac320ae
https: make https.get() accept a URL
...
https.get() now accepts either a URL (as a string) or an options object.
Refs #2859 .
Fixes #3882 .
2012-08-24 16:56:06 +02:00
Ben Kelly
c6185c8484
doc: Improve cross-linking in API docs markdown
...
Cross-link EventEmitter references in API docs to events.html
Fix broken cross-reference links with wrong anchor names in API docs.
2012-06-15 09:44:37 -07:00
isaacs
5164ae3838
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
...
Conflicts:
ChangeLog
deps/uv/include/uv-private/uv-unix.h
deps/uv/src/unix/core.c
deps/uv/src/unix/sunos.c
deps/v8/src/runtime.cc
doc/api/crypto.markdown
lib/http.js
src/node_version.h
test/gc/test-http-client-timeout.js
wscript
2012-05-15 11:37:34 -07:00
ssuda
fb7348ae06
crypto: add PKCS12/PFX support
...
Fixes #2845 .
2012-05-14 17:12:59 +02: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
c205d3b53a
doc refactor: https
2012-02-29 16:04:52 -08:00
isaacs
2806c6ce28
doc refactor: https
2012-02-27 11:14:34 -08:00
koichik
ae762b620e
docs: add ciphers option to https.request()
2012-02-25 23:17:05 +09:00
koichik
f8c335d0ca
tls: enable rejectUnauthorized option to client
...
Fiexes #2247 .
2011-12-07 22:47:06 +09:00
kyle@dontkry.com
34f34e4411
docs: fix typo
...
Fixes #2193 .
2011-11-27 01:45:27 +09:00
koichik
f53d092a2a
tls, https: add passphrase option
...
Fixes #1925 .
2011-10-31 17:36:43 +09:00
koichik
00aa8935d7
docs: improvement fs, http and https
2011-10-22 23:40:15 +09:00
seebees
216570b5e1
Lint
2011-10-22 14:14:40 +09:00
seebees
a2eaddaa51
Documentation update
...
http.markdown
note options now align with url.parse
added note that hostname is preferred over host.
added auth
added not that setting an explicit Authorization header will override basic authentication with 'auth'
https.markdown
Made a link to http.request and noted that all http.request options are valid.
url.markdown
added path option
2011-10-22 14:14:40 +09:00
koichik
244675cab1
doc: HTTPS client's options
2011-09-14 23:48:42 +09:00
koichik
e7f64a7d41
doc: HTTPS client's options
...
Fixes #1494 .
2011-09-14 20:17:30 +09:00
koichik
1343ee8d54
Doc improvements.
2011-04-28 04:54:28 -04:00
Ryan Dahl
9a8e843ca3
Document options for https.request
...
Closes GH-768.
2011-03-10 13:34:50 -08:00
Ryan Dahl
db8736ad93
Add https.get()
2011-01-21 13:21:01 -08:00
Ryan Dahl
e65f6b4ce1
Initial pass at https client
2011-01-21 13:13:02 -08:00
