{"action":"created","comment":{"url":"https://api.github.com/repos/nodejs/node/pulls/comments/64437552","id":64437552,"diff_hunk":"@@ -1112,22 +1290,112 @@ class SimpleProtocol extends Readable {\n // with the parsed header data.\n ```\n \n-### Class: stream.Transform\n+### Implementing a Duplex Stream\n+\n+A [Duplex][] stream is one that implements both [Readable][] and [Writable][],\n+such as a TCP socket connection.  \n+\n+Because Javascript does not have support for multiple inheritance, the \n+`stream.Duplex` class is extended to implement a [Duplex][] stream (as opposed\n+to extending the `stream.Readable` *and* `stream.Writable` classes).\n+\n+*Note*: The `stream.Duplex` class prototypically inherits from `stream.Readable`\n+and parasitically from `stream.Writable`.\n+\n+Custom Duplex streams *must* call the `new stream.Duplex([options])`\n+constructor and implement *both* the `readable.\\_read()` and\n+`writable.\\_write()` methods.\n+\n+#### new stream.Duplex(options)\n+\n+* `options` {Object} Passed to both Writable and Readable\n+  constructors. Also has the following fields:\n+  * `allowHalfOpen` {Boolean} Default = `true`. If set to `false`, then\n+    the stream will automatically end the readable side when the\n+    writable side ends and vice versa.\n+  * `readableObjectMode` {Boolean} Default = `false`. Sets `objectMode`\n+    for readable side of the stream. Has no effect if `objectMode`\n+    is `true`.\n+  * `writableObjectMode` {Boolean} Default = `false`. Sets `objectMode`\n+    for writable side of the stream. Has no effect if `objectMode`\n+    is `true`.\n+\n+For example:\n+\n+```js\n+const Duplex = require('stream').Duplex;\n+\n+class MyDuplex extends Duplex {\n+  constructor(options) {\n+    super(options);\n+  }\n+}\n+```\n+\n+Or, when using pre-ES6 style constructors:\n+\n+```js\n+const Duplex = require('stream').Duplex;\n+const util = require('util');\n+\n+function MyDuplex(options) {\n+  if (!(this instanceof MyDuplex))\n+    return new MyDuplex(options);\n+  Duplex.call(this, options);\n+}\n+util.inherits(MyDuplex, Duplex);\n+```\n+\n+#### An Example Duplex Stream\n+\n+The following illustrates a simple example of a Duplex stream that buffers\n+incoming written data via the [Writable][] interface that is read back out\n+via the [Readable][] interface.\n+\n+```js\n+const Duplex = require('stream').Duplex;\n+const kBuf = Symbol('buffer');\n+\n+class MyDuplex extends Duplex {\n+  constructor(options) {\n+    super(options);\n+  }\n+\n+  _write(chunk, encoding, next) {\n+    var buffer = this[kBuf];\n+    if (!Array.isArray(buffer))\n+      buffer = this[kBuf] = [];\n+    buffer.push(chunk);\n+    next();\n+  }\n+\n+  _read(size) {\n+    var buffer = this[kBuf];\n+    if (Array.isArray(buffer))\n+      buffer.forEach((chunk) => this.push(chunk));\n+  }\n+}\n+```","path":"doc/api/stream.md","position":1700,"original_position":1700,"commit_id":"e6907a1a8c3d328e6630d4641110dff03af83bee","original_commit_id":"e6907a1a8c3d328e6630d4641110dff03af83bee","user":{"login":"jasnell","id":439929,"avatar_url":"https://avatars.githubusercontent.com/u/439929?v=3","gravatar_id":"","url":"https://api.github.com/users/jasnell","html_url":"https://github.com/jasnell","followers_url":"https://api.github.com/users/jasnell/followers","following_url":"https://api.github.com/users/jasnell/following{/other_user}","gists_url":"https://api.github.com/users/jasnell/gists{/gist_id}","starred_url":"https://api.github.com/users/jasnell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasnell/subscriptions","organizations_url":"https://api.github.com/users/jasnell/orgs","repos_url":"https://api.github.com/users/jasnell/repos","events_url":"https://api.github.com/users/jasnell/events{/privacy}","received_events_url":"https://api.github.com/users/jasnell/received_events","type":"User","site_admin":false},"body":"Yeah, I struggled to come up with a clear, concise, *useful* example for Duplex that wasn't better implemented as just a Transform. Happy to switch this example out with a better one!","created_at":"2016-05-24T17:28:21Z","updated_at":"2016-05-24T17:28:21Z","html_url":"https://github.com/nodejs/node/pull/6947#discussion_r64437552","pull_request_url":"https://api.github.com/repos/nodejs/node/pulls/6947","_links":{"self":{"href":"https://api.github.com/repos/nodejs/node/pulls/comments/64437552"},"html":{"href":"https://github.com/nodejs/node/pull/6947#discussion_r64437552"},"pull_request":{"href":"https://api.github.com/repos/nodejs/node/pulls/6947"}}},"pull_request":{"url":"https://api.github.com/repos/nodejs/node/pulls/6947","id":71159935,"html_url":"https://github.com/nodejs/node/pull/6947","diff_url":"https://github.com/nodejs/node/pull/6947.diff","patch_url":"https://github.com/nodejs/node/pull/6947.patch","issue_url":"https://api.github.com/repos/nodejs/node/issues/6947","number":6947,"state":"open","locked":false,"title":"doc: general improvements to stream.md copy","user":{"login":"jasnell","id":439929,"avatar_url":"https://avatars.githubusercontent.com/u/439929?v=3","gravatar_id":"","url":"https://api.github.com/users/jasnell","html_url":"https://github.com/jasnell","followers_url":"https://api.github.com/users/jasnell/followers","following_url":"https://api.github.com/users/jasnell/following{/other_user}","gists_url":"https://api.github.com/users/jasnell/gists{/gist_id}","starred_url":"https://api.github.com/users/jasnell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasnell/subscriptions","organizations_url":"https://api.github.com/users/jasnell/orgs","repos_url":"https://api.github.com/users/jasnell/repos","events_url":"https://api.github.com/users/jasnell/events{/privacy}","received_events_url":"https://api.github.com/users/jasnell/received_events","type":"User","site_admin":false},"body":"##### Checklist\r\n\r\n- [x] documentation is changed or added\r\n- [x] the commit message follows commit guidelines\r\n\r\n##### Affected core subsystem(s)\r\n\r\ndoc (stream)\r\n\r\n##### Description of change\r\n\r\nGeneral improvements to stream.md. This one is significantly larger and will need a more detailed review.\r\n\r\n@nodejs/documentation @nodejs/streams \r\n","created_at":"2016-05-24T05:32:11Z","updated_at":"2016-05-24T17:28:21Z","closed_at":null,"merged_at":null,"merge_commit_sha":"471d438d3ace8fabec773e04c51f83656479282e","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/nodejs/node/pulls/6947/commits","review_comments_url":"https://api.github.com/repos/nodejs/node/pulls/6947/comments","review_comment_url":"https://api.github.com/repos/nodejs/node/pulls/comments{/number}","comments_url":"https://api.github.com/repos/nodejs/node/issues/6947/comments","statuses_url":"https://api.github.com/repos/nodejs/node/statuses/e6907a1a8c3d328e6630d4641110dff03af83bee","head":{"label":"jasnell:doc-stream-copy","ref":"doc-stream-copy","sha":"e6907a1a8c3d328e6630d4641110dff03af83bee","user":{"login":"jasnell","id":439929,"avatar_url":"https://avatars.githubusercontent.com/u/439929?v=3","gravatar_id":"","url":"https://api.github.com/users/jasnell","html_url":"https://github.com/jasnell","followers_url":"https://api.github.com/users/jasnell/followers","following_url":"https://api.github.com/users/jasnell/following{/other_user}","gists_url":"https://api.github.com/users/jasnell/gists{/gist_id}","starred_url":"https://api.github.com/users/jasnell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasnell/subscriptions","organizations_url":"https://api.github.com/users/jasnell/orgs","repos_url":"https://api.github.com/users/jasnell/repos","events_url":"https://api.github.com/users/jasnell/events{/privacy}","received_events_url":"https://api.github.com/users/jasnell/received_events","type":"User","site_admin":false},"repo":{"id":37868459,"name":"node","full_name":"jasnell/node","owner":{"login":"jasnell","id":439929,"avatar_url":"https://avatars.githubusercontent.com/u/439929?v=3","gravatar_id":"","url":"https://api.github.com/users/jasnell","html_url":"https://github.com/jasnell","followers_url":"https://api.github.com/users/jasnell/followers","following_url":"https://api.github.com/users/jasnell/following{/other_user}","gists_url":"https://api.github.com/users/jasnell/gists{/gist_id}","starred_url":"https://api.github.com/users/jasnell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasnell/subscriptions","organizations_url":"https://api.github.com/users/jasnell/orgs","repos_url":"https://api.github.com/users/jasnell/repos","events_url":"https://api.github.com/users/jasnell/events{/privacy}","received_events_url":"https://api.github.com/users/jasnell/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/jasnell/node","description":"Future Node.js releases will be based on io.js","fork":true,"url":"https://api.github.com/repos/jasnell/node","forks_url":"https://api.github.com/repos/jasnell/node/forks","keys_url":"https://api.github.com/repos/jasnell/node/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jasnell/node/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jasnell/node/teams","hooks_url":"https://api.github.com/repos/jasnell/node/hooks","issue_events_url":"https://api.github.com/repos/jasnell/node/issues/events{/number}","events_url":"https://api.github.com/repos/jasnell/node/events","assignees_url":"https://api.github.com/repos/jasnell/node/assignees{/user}","branches_url":"https://api.github.com/repos/jasnell/node/branches{/branch}","tags_url":"https://api.github.com/repos/jasnell/node/tags","blobs_url":"https://api.github.com/repos/jasnell/node/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jasnell/node/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jasnell/node/git/refs{/sha}","trees_url":"https://api.github.com/repos/jasnell/node/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jasnell/node/statuses/{sha}","languages_url":"https://api.github.com/repos/jasnell/node/languages","stargazers_url":"https://api.github.com/repos/jasnell/node/stargazers","contributors_url":"https://api.github.com/repos/jasnell/node/contributors","subscribers_url":"https://api.github.com/repos/jasnell/node/subscribers","subscription_url":"https://api.github.com/repos/jasnell/node/subscription","commits_url":"https://api.github.com/repos/jasnell/node/commits{/sha}","git_commits_url":"https://api.github.com/repos/jasnell/node/git/commits{/sha}","comments_url":"https://api.github.com/repos/jasnell/node/comments{/number}","issue_comment_url":"https://api.github.com/repos/jasnell/node/issues/comments{/number}","contents_url":"https://api.github.com/repos/jasnell/node/contents/{+path}","compare_url":"https://api.github.com/repos/jasnell/node/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jasnell/node/merges","archive_url":"https://api.github.com/repos/jasnell/node/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jasnell/node/downloads","issues_url":"https://api.github.com/repos/jasnell/node/issues{/number}","pulls_url":"https://api.github.com/repos/jasnell/node/pulls{/number}","milestones_url":"https://api.github.com/repos/jasnell/node/milestones{/number}","notifications_url":"https://api.github.com/repos/jasnell/node/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jasnell/node/labels{/name}","releases_url":"https://api.github.com/repos/jasnell/node/releases{/id}","deployments_url":"https://api.github.com/repos/jasnell/node/deployments","created_at":"2015-06-22T17:01:18Z","updated_at":"2016-01-11T18:47:43Z","pushed_at":"2016-05-24T15:19:18Z","git_url":"git://github.com/jasnell/node.git","ssh_url":"git@github.com:jasnell/node.git","clone_url":"https://github.com/jasnell/node.git","svn_url":"https://github.com/jasnell/node","homepage":"https://iojs.org","size":207334,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":1,"forks":3,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"nodejs:master","ref":"master","sha":"20501275d376f1f3e950c2131dfad71c931f79e7","user":{"login":"nodejs","id":9950313,"avatar_url":"https://avatars.githubusercontent.com/u/9950313?v=3","gravatar_id":"","url":"https://api.github.com/users/nodejs","html_url":"https://github.com/nodejs","followers_url":"https://api.github.com/users/nodejs/followers","following_url":"https://api.github.com/users/nodejs/following{/other_user}","gists_url":"https://api.github.com/users/nodejs/gists{/gist_id}","starred_url":"https://api.github.com/users/nodejs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nodejs/subscriptions","organizations_url":"https://api.github.com/users/nodejs/orgs","repos_url":"https://api.github.com/users/nodejs/repos","events_url":"https://api.github.com/users/nodejs/events{/privacy}","received_events_url":"https://api.github.com/users/nodejs/received_events","type":"Organization","site_admin":false},"repo":{"id":27193779,"name":"node","full_name":"nodejs/node","owner":{"login":"nodejs","id":9950313,"avatar_url":"https://avatars.githubusercontent.com/u/9950313?v=3","gravatar_id":"","url":"https://api.github.com/users/nodejs","html_url":"https://github.com/nodejs","followers_url":"https://api.github.com/users/nodejs/followers","following_url":"https://api.github.com/users/nodejs/following{/other_user}","gists_url":"https://api.github.com/users/nodejs/gists{/gist_id}","starred_url":"https://api.github.com/users/nodejs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nodejs/subscriptions","organizations_url":"https://api.github.com/users/nodejs/orgs","repos_url":"https://api.github.com/users/nodejs/repos","events_url":"https://api.github.com/users/nodejs/events{/privacy}","received_events_url":"https://api.github.com/users/nodejs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/nodejs/node","description":"Node.js JavaScript runtime :sparkles::turtle::rocket::sparkles:","fork":false,"url":"https://api.github.com/repos/nodejs/node","forks_url":"https://api.github.com/repos/nodejs/node/forks","keys_url":"https://api.github.com/repos/nodejs/node/keys{/key_id}","collaborators_url":"https://api.github.com/repos/nodejs/node/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/nodejs/node/teams","hooks_url":"https://api.github.com/repos/nodejs/node/hooks","issue_events_url":"https://api.github.com/repos/nodejs/node/issues/events{/number}","events_url":"https://api.github.com/repos/nodejs/node/events","assignees_url":"https://api.github.com/repos/nodejs/node/assignees{/user}","branches_url":"https://api.github.com/repos/nodejs/node/branches{/branch}","tags_url":"https://api.github.com/repos/nodejs/node/tags","blobs_url":"https://api.github.com/repos/nodejs/node/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/nodejs/node/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/nodejs/node/git/refs{/sha}","trees_url":"https://api.github.com/repos/nodejs/node/git/trees{/sha}","statuses_url":"https://api.github.com/repos/nodejs/node/statuses/{sha}","languages_url":"https://api.github.com/repos/nodejs/node/languages","stargazers_url":"https://api.github.com/repos/nodejs/node/stargazers","contributors_url":"https://api.github.com/repos/nodejs/node/contributors","subscribers_url":"https://api.github.com/repos/nodejs/node/subscribers","subscription_url":"https://api.github.com/repos/nodejs/node/subscription","commits_url":"https://api.github.com/repos/nodejs/node/commits{/sha}","git_commits_url":"https://api.github.com/repos/nodejs/node/git/commits{/sha}","comments_url":"https://api.github.com/repos/nodejs/node/comments{/number}","issue_comment_url":"https://api.github.com/repos/nodejs/node/issues/comments{/number}","contents_url":"https://api.github.com/repos/nodejs/node/contents/{+path}","compare_url":"https://api.github.com/repos/nodejs/node/compare/{base}...{head}","merges_url":"https://api.github.com/repos/nodejs/node/merges","archive_url":"https://api.github.com/repos/nodejs/node/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/nodejs/node/downloads","issues_url":"https://api.github.com/repos/nodejs/node/issues{/number}","pulls_url":"https://api.github.com/repos/nodejs/node/pulls{/number}","milestones_url":"https://api.github.com/repos/nodejs/node/milestones{/number}","notifications_url":"https://api.github.com/repos/nodejs/node/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/nodejs/node/labels{/name}","releases_url":"https://api.github.com/repos/nodejs/node/releases{/id}","deployments_url":"https://api.github.com/repos/nodejs/node/deployments","created_at":"2014-11-26T19:57:11Z","updated_at":"2016-05-24T15:50:29Z","pushed_at":"2016-05-24T17:25:22Z","git_url":"git://github.com/nodejs/node.git","ssh_url":"git@github.com:nodejs/node.git","clone_url":"https://github.com/nodejs/node.git","svn_url":"https://github.com/nodejs/node","homepage":"https://nodejs.org","size":276243,"stargazers_count":23438,"watchers_count":23438,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3345,"mirror_url":null,"open_issues_count":675,"forks":3345,"open_issues":675,"watchers":23438,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/nodejs/node/pulls/6947"},"html":{"href":"https://github.com/nodejs/node/pull/6947"},"issue":{"href":"https://api.github.com/repos/nodejs/node/issues/6947"},"comments":{"href":"https://api.github.com/repos/nodejs/node/issues/6947/comments"},"review_comments":{"href":"https://api.github.com/repos/nodejs/node/pulls/6947/comments"},"review_comment":{"href":"https://api.github.com/repos/nodejs/node/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/nodejs/node/pulls/6947/commits"},"statuses":{"href":"https://api.github.com/repos/nodejs/node/statuses/e6907a1a8c3d328e6630d4641110dff03af83bee"}}}}
{"actor":{"display_login":"jasnell"}}