Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
Close #1303 Stream.pipe returns the destination
Browse files Browse the repository at this point in the history
Squashed:

* Simple change to make Stream.pipe(destination) return the destination Stream
* Test: ensure Stream.pipe(destination) returns the destination Stream
* updated Stream.pipe() documentation to reflect that it now returns the
  destination stream
  • Loading branch information
tmpvar authored and isaacs committed Jul 14, 2011
1 parent 9b5098f commit b722aaa
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/streams.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Connects this read stream to `destination` WriteStream. Incoming
data on this stream gets written to `destination`. The destination and source
streams are kept in sync by pausing and resuming as necessary.

This function returns the `destination` stream.

Emulating the Unix `cat` command:

process.stdin.resume();
Expand Down
3 changes: 3 additions & 0 deletions lib/stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,7 @@ Stream.prototype.pipe = function(dest, options) {
dest.on('close', cleanup);

dest.emit('pipe', source);

// Allow for unix-like usage: A.pipe(B).pipe(C)
return dest;
};
33 changes: 33 additions & 0 deletions test/simple/test-pipe-return-val.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

// This test ensures SourceStream.pipe(DestStream) returns DestStream

var Stream = require('stream').Stream;
var assert = require('assert');
var util = require('util');

var sourceStream = new Stream();
var destStream = new Stream();
var result = sourceStream.pipe(destStream);

assert.strictEqual(result, destStream);

0 comments on commit b722aaa

Please sign in to comment.