external-Readable.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>Documentation External: Readable</title>
  7. <!--[if lt IE 9]>
  8. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  9. <![endif]-->
  10. <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  11. <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
  12. </head>
  13. <body>
  14. <div class="navbar navbar-default navbar-fixed-top ">
  15. <div class="container">
  16. <div class="navbar-header">
  17. <a class="navbar-brand" href="index.html">Documentation</a>
  18. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  19. <span class="icon-bar"></span>
  20. <span class="icon-bar"></span>
  21. <span class="icon-bar"></span>
  22. </button>
  23. </div>
  24. <div class="navbar-collapse collapse" id="topNavigation">
  25. <ul class="nav navbar-nav">
  26. <li class="dropdown">
  27. <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  28. <ul class="dropdown-menu ">
  29. <li><a href="grpc.html">grpc</a></li><li><a href="grpc.credentials.html">grpc.credentials</a></li>
  30. </ul>
  31. </li>
  32. <li class="dropdown">
  33. <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  34. <ul class="dropdown-menu ">
  35. <li><a href="grpc.Client.html">grpc.Client</a></li><li><a href="grpc.credentials-CallCredentials.html">grpc.credentials~CallCredentials</a></li><li><a href="grpc.credentials-ChannelCredentials.html">grpc.credentials~ChannelCredentials</a></li><li><a href="grpc.Metadata.html">grpc.Metadata</a></li><li><a href="grpc.Server.html">grpc.Server</a></li><li><a href="grpc.ServerCredentials.html">grpc.ServerCredentials</a></li><li><a href="grpc-ClientDuplexStream.html">grpc~ClientDuplexStream</a></li><li><a href="grpc-ClientReadableStream.html">grpc~ClientReadableStream</a></li><li><a href="grpc-ClientUnaryCall.html">grpc~ClientUnaryCall</a></li><li><a href="grpc-ClientWritableStream.html">grpc~ClientWritableStream</a></li><li><a href="grpc-ServerDuplexStream.html">grpc~ServerDuplexStream</a></li><li><a href="grpc-ServerReadableStream.html">grpc~ServerReadableStream</a></li><li><a href="grpc-ServerUnaryCall.html">grpc~ServerUnaryCall</a></li><li><a href="grpc-ServerWritableStream.html">grpc~ServerWritableStream</a></li>
  36. </ul>
  37. </li>
  38. <li class="dropdown">
  39. <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
  40. <ul class="dropdown-menu ">
  41. <li><a href="grpc-ClientDuplexStream.html#event:metadata">grpc~ClientDuplexStream#metadata</a></li><li><a href="grpc-ClientDuplexStream.html#event:status">grpc~ClientDuplexStream#status</a></li><li><a href="grpc-ClientReadableStream.html#event:metadata">grpc~ClientReadableStream#metadata</a></li><li><a href="grpc-ClientReadableStream.html#event:status">grpc~ClientReadableStream#status</a></li><li><a href="grpc-ClientUnaryCall.html#event:metadata">grpc~ClientUnaryCall#event:metadata</a></li><li><a href="grpc-ClientUnaryCall.html#event:status">grpc~ClientUnaryCall#event:status</a></li><li><a href="grpc-ClientWritableStream.html#event:metadata">grpc~ClientWritableStream#metadata</a></li><li><a href="grpc-ClientWritableStream.html#event:status">grpc~ClientWritableStream#status</a></li><li><a href="grpc-ServerDuplexStream.html#~event:cancelled">grpc~ServerDuplexStream~event:cancelled</a></li><li><a href="grpc-ServerReadableStream.html#~event:cancelled">grpc~ServerReadableStream~event:cancelled</a></li><li><a href="grpc-ServerUnaryCall.html#~event:cancelled">grpc~ServerUnaryCall~event:cancelled</a></li><li><a href="grpc-ServerWritableStream.html#~event:cancelled">grpc~ServerWritableStream~event:cancelled</a></li>
  42. </ul>
  43. </li>
  44. <li class="dropdown">
  45. <a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
  46. <ul class="dropdown-menu ">
  47. <li><a href="external-Duplex.html">Duplex</a></li><li><a href="external-EventEmitter.html">EventEmitter</a></li><li><a href="external-GoogleCredential.html">GoogleCredential</a></li><li><a href="external-Readable.html">Readable</a></li><li><a href="external-Writable.html">Writable</a></li>
  48. </ul>
  49. </li>
  50. </ul>
  51. <div class="col-sm-3 col-md-3">
  52. <form class="navbar-form" role="search">
  53. <div class="input-group">
  54. <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  55. <div class="input-group-btn">
  56. <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  57. </div>
  58. </div>
  59. </form>
  60. </div>
  61. </div>
  62. </div>
  63. </div>
  64. <div class="container" id="toc-content">
  65. <div class="row">
  66. <div class="col-md-8">
  67. <div id="main">
  68. <h1 class="page-title">External: Readable</h1>
  69. <section>
  70. <header>
  71. <h2>
  72. Readable
  73. </h2>
  74. </header>
  75. <article>
  76. <div class="container-overview">
  77. <div class="description"><p>The Readable class in the stream standard module</p></div>
  78. <dl class="details">
  79. <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
  80. <dd class="tag-see">
  81. <ul>
  82. <li><a href="https://nodejs.org/api/stream.html#stream_readable_streams">https://nodejs.org/api/stream.html#stream_readable_streams</a></li>
  83. </ul>
  84. </dd>
  85. </dl>
  86. </div>
  87. </article>
  88. </section>
  89. </div>
  90. </div>
  91. <div class="clearfix"></div>
  92. <div class="col-md-3">
  93. <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
  94. </div>
  95. </div>
  96. </div>
  97. <div class="modal fade" id="searchResults">
  98. <div class="modal-dialog">
  99. <div class="modal-content">
  100. <div class="modal-header">
  101. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  102. <h4 class="modal-title">Search results</h4>
  103. </div>
  104. <div class="modal-body"></div>
  105. <div class="modal-footer">
  106. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  107. </div>
  108. </div><!-- /.modal-content -->
  109. </div><!-- /.modal-dialog -->
  110. </div>
  111. <footer>
  112. <span class="jsdoc-message">
  113. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
  114. on 2018-01-16T12:05:13-05:00
  115. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
  116. </span>
  117. </footer>
  118. <script src="scripts/docstrap.lib.js"></script>
  119. <script src="scripts/toc.js"></script>
  120. <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
  121. <script>
  122. $( function () {
  123. $( "[id*='$']" ).each( function () {
  124. var $this = $( this );
  125. $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
  126. } );
  127. $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
  128. var $this = $( this );
  129. var example = $this.find( "code" );
  130. exampleText = example.html();
  131. var lang = /{@lang (.*?)}/.exec( exampleText );
  132. if ( lang && lang[1] ) {
  133. exampleText = exampleText.replace( lang[0], "" );
  134. example.html( exampleText );
  135. lang = lang[1];
  136. } else {
  137. var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
  138. lang = langClassMatch ? langClassMatch[1] : "javascript";
  139. }
  140. if ( lang ) {
  141. $this
  142. .addClass( "sunlight-highlight-" + lang )
  143. .addClass( "linenums" )
  144. .html( example.html() );
  145. }
  146. } );
  147. Sunlight.highlightAll( {
  148. lineNumbers : false,
  149. showMenu : true,
  150. enableDoclinks : true
  151. } );
  152. $.catchAnchorLinks( {
  153. navbarOffset: 10
  154. } );
  155. $( "#toc" ).toc( {
  156. anchorName : function ( i, heading, prefix ) {
  157. return $( heading ).attr( "id" ) || ( prefix + i );
  158. },
  159. selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
  160. showAndHide : false,
  161. smoothScrolling: true
  162. } );
  163. $( "#main span[id^='toc']" ).addClass( "toc-shim" );
  164. $( '.dropdown-toggle' ).dropdown();
  165. $( "table" ).each( function () {
  166. var $this = $( this );
  167. $this.addClass('table');
  168. } );
  169. } );
  170. </script>
  171. <!--Navigation and Symbol Display-->
  172. <!--Google Analytics-->
  173. <script type="text/javascript">
  174. $(document).ready(function() {
  175. SearcherDisplay.init();
  176. });
  177. </script>
  178. </body>
  179. </html>