{"action":"created","comment":{"url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/comments/77194503","id":77194503,"diff_hunk":"@@ -65,6 +67,30 @@ bye\n > npm i libp2p-tcp\n ```\n \n+## This module uses `pull-streams`\n+\n+We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).\n+\n+You can learn more about pull-streams at:\n+\n+- [The history of Node.js streams, nodebp April 2014](https://www.youtube.com/watch?v=g5ewQEuXjsQ)\n+- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)\n+- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)\n+- [pull-streams documentation](https://pull-stream.github.io/)\n+\n+### Converting `pull-streams` to Node.js Streams\n+\n+If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example:\n+\n+```\n+const pullToStream = require('pull-stream-to-stream')\n+\n+const nodeStreamInstance = pullToStream(pullStreamInstance)\n+// nodeStreamInstance is an instance of a Node.js Stream\n+```\n+\n+To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream\n+","path":"README.md","position":108,"original_position":108,"commit_id":"041d2eafe9b5964a052e39e288f43b8be2929639","original_commit_id":"041d2eafe9b5964a052e39e288f43b8be2929639","user":{"login":"diasdavid","id":1211152,"avatar_url":"https://avatars.githubusercontent.com/u/1211152?v=3","gravatar_id":"","url":"https://api.github.com/users/diasdavid","html_url":"https://github.com/diasdavid","followers_url":"https://api.github.com/users/diasdavid/followers","following_url":"https://api.github.com/users/diasdavid/following{/other_user}","gists_url":"https://api.github.com/users/diasdavid/gists{/gist_id}","starred_url":"https://api.github.com/users/diasdavid/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/diasdavid/subscriptions","organizations_url":"https://api.github.com/users/diasdavid/orgs","repos_url":"https://api.github.com/users/diasdavid/repos","events_url":"https://api.github.com/users/diasdavid/events{/privacy}","received_events_url":"https://api.github.com/users/diasdavid/received_events","type":"User","site_admin":false},"body":"@RichardLitt could you review this `pull-streams` segment. Thank you :) ","created_at":"2016-09-01T15:17:39Z","updated_at":"2016-09-01T15:17:39Z","html_url":"https://github.com/libp2p/js-libp2p-tcp/pull/20#discussion_r77194503","pull_request_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20","_links":{"self":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/comments/77194503"},"html":{"href":"https://github.com/libp2p/js-libp2p-tcp/pull/20#discussion_r77194503"},"pull_request":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20"}}},"pull_request":{"url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20","id":80236180,"html_url":"https://github.com/libp2p/js-libp2p-tcp/pull/20","diff_url":"https://github.com/libp2p/js-libp2p-tcp/pull/20.diff","patch_url":"https://github.com/libp2p/js-libp2p-tcp/pull/20.patch","issue_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/20","number":20,"state":"open","locked":false,"title":"Migrate to pull-streams","user":{"login":"dignifiedquire","id":790842,"avatar_url":"https://avatars.githubusercontent.com/u/790842?v=3","gravatar_id":"","url":"https://api.github.com/users/dignifiedquire","html_url":"https://github.com/dignifiedquire","followers_url":"https://api.github.com/users/dignifiedquire/followers","following_url":"https://api.github.com/users/dignifiedquire/following{/other_user}","gists_url":"https://api.github.com/users/dignifiedquire/gists{/gist_id}","starred_url":"https://api.github.com/users/dignifiedquire/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dignifiedquire/subscriptions","organizations_url":"https://api.github.com/users/dignifiedquire/orgs","repos_url":"https://api.github.com/users/dignifiedquire/repos","events_url":"https://api.github.com/users/dignifiedquire/events{/privacy}","received_events_url":"https://api.github.com/users/dignifiedquire/received_events","type":"User","site_admin":false},"body":"- Uses `net` from node core for now\r\n- Todo for later, polish `pull-net` and use that\r\n- Two failing tests, one is related to unfinished `interface-connection`, the other needs some investigation.\r\n","created_at":"2016-08-05T12:35:29Z","updated_at":"2016-09-01T15:17:39Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3b297650e939cb80a35ef2ee0410b1fb8dff8e25","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20/commits","review_comments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20/comments","review_comment_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/comments{/number}","comments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/20/comments","statuses_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/statuses/041d2eafe9b5964a052e39e288f43b8be2929639","head":{"label":"libp2p:pull","ref":"pull","sha":"041d2eafe9b5964a052e39e288f43b8be2929639","user":{"login":"libp2p","id":14838238,"avatar_url":"https://avatars.githubusercontent.com/u/14838238?v=3","gravatar_id":"","url":"https://api.github.com/users/libp2p","html_url":"https://github.com/libp2p","followers_url":"https://api.github.com/users/libp2p/followers","following_url":"https://api.github.com/users/libp2p/following{/other_user}","gists_url":"https://api.github.com/users/libp2p/gists{/gist_id}","starred_url":"https://api.github.com/users/libp2p/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/libp2p/subscriptions","organizations_url":"https://api.github.com/users/libp2p/orgs","repos_url":"https://api.github.com/users/libp2p/repos","events_url":"https://api.github.com/users/libp2p/events{/privacy}","received_events_url":"https://api.github.com/users/libp2p/received_events","type":"Organization","site_admin":false},"repo":{"id":42521859,"name":"js-libp2p-tcp","full_name":"libp2p/js-libp2p-tcp","owner":{"login":"libp2p","id":14838238,"avatar_url":"https://avatars.githubusercontent.com/u/14838238?v=3","gravatar_id":"","url":"https://api.github.com/users/libp2p","html_url":"https://github.com/libp2p","followers_url":"https://api.github.com/users/libp2p/followers","following_url":"https://api.github.com/users/libp2p/following{/other_user}","gists_url":"https://api.github.com/users/libp2p/gists{/gist_id}","starred_url":"https://api.github.com/users/libp2p/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/libp2p/subscriptions","organizations_url":"https://api.github.com/users/libp2p/orgs","repos_url":"https://api.github.com/users/libp2p/repos","events_url":"https://api.github.com/users/libp2p/events{/privacy}","received_events_url":"https://api.github.com/users/libp2p/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/libp2p/js-libp2p-tcp","description":"JavaScript implementation of the TCP module that libp2p uses that implements the abstract-transport interface","fork":false,"url":"https://api.github.com/repos/libp2p/js-libp2p-tcp","forks_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/forks","keys_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/teams","hooks_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/hooks","issue_events_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/events{/number}","events_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/events","assignees_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/assignees{/user}","branches_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/branches{/branch}","tags_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/tags","blobs_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/refs{/sha}","trees_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/statuses/{sha}","languages_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/languages","stargazers_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/stargazers","contributors_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/contributors","subscribers_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/subscribers","subscription_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/subscription","commits_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/commits{/sha}","git_commits_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/commits{/sha}","comments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/comments{/number}","issue_comment_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/comments{/number}","contents_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/contents/{+path}","compare_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/merges","archive_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/downloads","issues_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues{/number}","pulls_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls{/number}","milestones_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/milestones{/number}","notifications_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/labels{/name}","releases_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/releases{/id}","deployments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/deployments","created_at":"2015-09-15T13:42:08Z","updated_at":"2016-06-18T16:15:54Z","pushed_at":"2016-08-31T11:52:54Z","git_url":"git://github.com/libp2p/js-libp2p-tcp.git","ssh_url":"git@github.com:libp2p/js-libp2p-tcp.git","clone_url":"https://github.com/libp2p/js-libp2p-tcp.git","svn_url":"https://github.com/libp2p/js-libp2p-tcp","homepage":"","size":67,"stargazers_count":3,"watchers_count":3,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":6,"mirror_url":null,"open_issues_count":2,"forks":6,"open_issues":2,"watchers":3,"default_branch":"master"}},"base":{"label":"libp2p:master","ref":"master","sha":"9b61bbc04063b7699c2f7a6449370912c0d2a268","user":{"login":"libp2p","id":14838238,"avatar_url":"https://avatars.githubusercontent.com/u/14838238?v=3","gravatar_id":"","url":"https://api.github.com/users/libp2p","html_url":"https://github.com/libp2p","followers_url":"https://api.github.com/users/libp2p/followers","following_url":"https://api.github.com/users/libp2p/following{/other_user}","gists_url":"https://api.github.com/users/libp2p/gists{/gist_id}","starred_url":"https://api.github.com/users/libp2p/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/libp2p/subscriptions","organizations_url":"https://api.github.com/users/libp2p/orgs","repos_url":"https://api.github.com/users/libp2p/repos","events_url":"https://api.github.com/users/libp2p/events{/privacy}","received_events_url":"https://api.github.com/users/libp2p/received_events","type":"Organization","site_admin":false},"repo":{"id":42521859,"name":"js-libp2p-tcp","full_name":"libp2p/js-libp2p-tcp","owner":{"login":"libp2p","id":14838238,"avatar_url":"https://avatars.githubusercontent.com/u/14838238?v=3","gravatar_id":"","url":"https://api.github.com/users/libp2p","html_url":"https://github.com/libp2p","followers_url":"https://api.github.com/users/libp2p/followers","following_url":"https://api.github.com/users/libp2p/following{/other_user}","gists_url":"https://api.github.com/users/libp2p/gists{/gist_id}","starred_url":"https://api.github.com/users/libp2p/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/libp2p/subscriptions","organizations_url":"https://api.github.com/users/libp2p/orgs","repos_url":"https://api.github.com/users/libp2p/repos","events_url":"https://api.github.com/users/libp2p/events{/privacy}","received_events_url":"https://api.github.com/users/libp2p/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/libp2p/js-libp2p-tcp","description":"JavaScript implementation of the TCP module that libp2p uses that implements the abstract-transport interface","fork":false,"url":"https://api.github.com/repos/libp2p/js-libp2p-tcp","forks_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/forks","keys_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/teams","hooks_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/hooks","issue_events_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/events{/number}","events_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/events","assignees_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/assignees{/user}","branches_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/branches{/branch}","tags_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/tags","blobs_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/refs{/sha}","trees_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/statuses/{sha}","languages_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/languages","stargazers_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/stargazers","contributors_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/contributors","subscribers_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/subscribers","subscription_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/subscription","commits_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/commits{/sha}","git_commits_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/git/commits{/sha}","comments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/comments{/number}","issue_comment_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/comments{/number}","contents_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/contents/{+path}","compare_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/merges","archive_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/downloads","issues_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues{/number}","pulls_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls{/number}","milestones_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/milestones{/number}","notifications_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/labels{/name}","releases_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/releases{/id}","deployments_url":"https://api.github.com/repos/libp2p/js-libp2p-tcp/deployments","created_at":"2015-09-15T13:42:08Z","updated_at":"2016-06-18T16:15:54Z","pushed_at":"2016-08-31T11:52:54Z","git_url":"git://github.com/libp2p/js-libp2p-tcp.git","ssh_url":"git@github.com:libp2p/js-libp2p-tcp.git","clone_url":"https://github.com/libp2p/js-libp2p-tcp.git","svn_url":"https://github.com/libp2p/js-libp2p-tcp","homepage":"","size":67,"stargazers_count":3,"watchers_count":3,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":6,"mirror_url":null,"open_issues_count":2,"forks":6,"open_issues":2,"watchers":3,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20"},"html":{"href":"https://github.com/libp2p/js-libp2p-tcp/pull/20"},"issue":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/20"},"comments":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/issues/20/comments"},"review_comments":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20/comments"},"review_comment":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/pulls/20/commits"},"statuses":{"href":"https://api.github.com/repos/libp2p/js-libp2p-tcp/statuses/041d2eafe9b5964a052e39e288f43b8be2929639"}}}}
{"actor":{"display_login":"diasdavid"}}