Permalink
Browse files

Document return type on createReadStream()

  • Loading branch information...
1 parent f2b32fe commit c2ddd915442b2a1f597b655e63787ff61b60f89f Loren Segal committed Jan 23, 2013
Showing with 2 additions and 0 deletions.
  1. +2 −0 lib/request.js
View
@@ -243,6 +243,8 @@ AWS.Request = inherit({
* @example Piping a request body into a file
* var out = fs.createWriteStream('/path/to/outfile.jpg');
* s3.client.getObject(params).createReadStream().pipe(out);
+ * @return [Stream] the readable stream object that can be piped
+ * or read from (by registering 'data' event listeners).
*/
createReadStream: function createReadStream() {
var req = this;

0 comments on commit c2ddd91

Please sign in to comment.