@stdlib/assert-is-string-array

isStringArray

Test if a value is an array of strings.

Installation

npm install @stdlib/assert-is-string-array

Usage

var isStringArray = require( '@stdlib/assert-is-string-array' );

isStringArray( value )

Tests if a value is an array of strings.

var bool = isStringArray( [ 'beep', new String('boop') ] );
// returns true

bool = isStringArray( [ 'beep', null ] );
// returns false

isStringArray.primitives( value )

Tests if a value is an array containing only string primitives.

var bool = isStringArray.primitives( [ 'beep', 'boop' ] );
// returns true

bool = isStringArray.primitives( [ 'beep', new String('boop') ] );
// returns false

isStringArray.objects( value )

Tests if a value is an array containing only String objects.

var bool = isStringArray.objects( [ new String('beep'), new String('boop') ] );
// returns true

bool = isStringArray.objects( [ 'beep', new String('boop') ] );
// returns false

Examples

var isStringArray = require( '@stdlib/assert-is-string-array' );

var bool = isStringArray( [ 'Hello World!' ] );
// returns true

bool = isStringArray( [ 'a', 'b', 'c' ] );
// returns true

bool = isStringArray( [ new String( 'abc' ), 'def', 'ghi' ] );
// returns true

bool = isStringArray( 'abc' );
// returns false

bool = isStringArray( [] );
// returns false

bool = isStringArray( [ 'a', NaN ] );
// returns false

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.