Permalink
Browse files

Document the buffer option change.

  • Loading branch information...
1 parent e942d65 commit d830caacf463e26ab11d5df3448d309d83d79129 @slaskis slaskis committed Mar 2, 2012
Showing with 9 additions and 4 deletions.
  1. +7 −2 README.md
  2. +2 −2 lib/schemes/http.js
View
@@ -41,7 +41,7 @@ Uses the [addressable module](https://github.com/publicclass/addressable) for pa
### Options for all schemes
-* `stream` (boolean) For when you only want the callback to receive a stream instead of the complete body as the second argument. Defaults to `false`.
+* `buffer` (boolean) For when you only want the body to be buffered and returned as the second argument instead of receiving the direct stream. Defaults to `true`.
### Options for HTTP(S)
@@ -68,9 +68,14 @@ Uses the [addressable module](https://github.com/publicclass/addressable) for pa
## History
+### 0.4.0
+
+* [Change] Added the `buffer` option, which is an inverted `stream`, which is now deprecated.
+* [Fix] Avoid a global variable (by [senorpedro](https://github.com/senorpedro/))
+
### 0.3.5
-* [Fix] User Buffer.byteLength(body) only on strings, and body.length on Buffers.
+* [Fix] Use Buffer.byteLength(body) only on strings, and body.length on Buffers.
* [Fix] Support for broken redirect implementations that give relative Location: headers.
View
@@ -3,8 +3,8 @@
*
* Available options:
*
-* {Boolean} stream
-* For when you only want the callback to receive a stream instead of the complete body as the second argument. Defaults to `false`.
+* {Boolean} buffer
+* For when you only want the body to be buffered and returned as the second argument instead of receiving the direct stream. Defaults to `true`.
* {Boolean} follow
* Follow redirects. Defaults to `true`.
* {Object} headers

0 comments on commit d830caa

Please sign in to comment.