time-to-botec/js/node_modules/@stdlib/assert/is-vector-like/README.md

isVectorLike

Test if a value is a 1-dimensional ndarray-like object.

Usage

var isVectorLike = require( '@stdlib/assert/is-vector-like' );

isVectorLike( value )

Tests if a value is a 1-dimensional ndarray-like object.

var ndarray = require( '@stdlib/ndarray/ctor' );

var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 4 ], [ 1 ], 0, 'row-major' );
var bool = isVectorLike( arr );
// returns true

Examples

var ndarray = require( '@stdlib/ndarray/ctor' );
var isVectorLike = require( '@stdlib/assert/is-vector-like' );

var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 4 ], [ 1 ], 0, 'row-major' );
var out = isVectorLike( arr );
// returns true

out = isVectorLike( [ 1, 2, 3, 4 ] );
// returns false

out = isVectorLike( {} );
// returns false

out = isVectorLike( null );
// returns false