Skip to content

Commit 1a3828d

Browse files
author
James Halliday
committed
updated opts formatting
1 parent 2425efc commit 1a3828d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

readme.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ http.get({ path : '/beep' }, function (res) {
3131

3232
var http = require('http');
3333

34-
## var req = http.request(options, cb)
34+
## var req = http.request(opts, cb)
3535

36-
`options` can have:
36+
where `opts` are:
3737

38-
* method
39-
* path
40-
* headers={}, as an object mapping key names to string or Array values
41-
* host=window.location.host
42-
* port=window.location.port
38+
* `opts.method='GET'` - http method verb
39+
* `opts.path` - path string, example: `'/foo/bar?baz=555'`
40+
* `opts.headers={}` - as an object mapping key names to string or Array values
41+
* `opts.host=window.location.host` - http host
42+
* `opts.port=window.location.port` - http port
4343

4444
The callback will be called with the response object.
4545

0 commit comments

Comments
 (0)