main.js (1536B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 /* eslint-disable no-underscore-dangle */ 20 21 'use strict'; 22 23 // MODULES // 24 25 var isNodeStreamLike = require( './../../is-node-stream-like' ); 26 27 28 // MAIN // 29 30 /** 31 * Tests if a value is Node readable stream-like. 32 * 33 * @param {*} value - value to test 34 * @returns {boolean} boolean indicating if a value is Node readable stream-like 35 * 36 * @example 37 * var transformStream = require( '@stdlib/streams/node/transform' ); 38 * 39 * var stream = transformStream(); 40 * 41 * var bool = isNodeReadableStreamLike( stream ); 42 * // returns true 43 * 44 * bool = isNodeReadableStreamLike( {} ); 45 * // returns false 46 */ 47 function isNodeReadableStreamLike( value ) { 48 return ( 49 // Must be stream-like: 50 isNodeStreamLike( value ) && 51 52 // Should have readable stream methods: 53 typeof value._read === 'function' && 54 55 // Should have readable stream state: 56 typeof value._readableState === 'object' 57 ); 58 } 59 60 61 // EXPORTS // 62 63 module.exports = isNodeReadableStreamLike;