Plato on Github
Report Home
src/interfaces/readablestream.js
Maintainability
100.00
Lines of code
43
Difficulty
2.00
Estimated Errors
0.01
Function weight
By Complexity
By SLOC
/** * @file IReadableStream interface * @since 0.1.9 */ /*#ifndef(UMD)*/ "use strict"; /*global _gpfDefineInterface*/ // Internal interface definition helper /*global _gpfSyncReadSourceJSON*/ // Reads a source json file (only in source mode) /*exported _gpfIReadableStream*/ // gpf.interfaces.IReadableStream /*#endif*/ /** * The Readable stream interface is the abstraction for a source of data that you are reading from. * In other words, data comes out of a Readable stream. * * @interface gpf.interfaces.IReadableStream * @since 0.1.9 */ /** * Read all data from the underlying source. Chunk of data is passed to the {@link gpf.interfaces.IWritableStream}. * * @method gpf.interfaces.IReadableStream#read * @param {gpf.interfaces.IWritableStream} output Stream that receives chunk of data * @return {Promise} Resolved when the stream has ended * @since 0.1.9 */ /** * IReadableStream interface specifier * * @type {gpf.interfaces.IReadableStream} * @since 0.1.9 */ var _gpfIReadableStream = _gpfDefineInterface("ReadableStream", _gpfSyncReadSourceJSON("interfaces/readablestream.json")); /*#ifndef(UMD)*/ // Generates an empty function to reflect the null complexity of this module (function _gpfInterfacesReadablestream () {}()); /*#endif*/