@stdlib/assert-is-string

isString

Test if a value is a string.

Installation

npm install @stdlib/assert-is-string

Usage

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

isString( value )

Tests if a value is a string.

var bool = isString( 'beep' );
// returns true

bool = isString( new String( 'beep' ) );
// returns true

isString.isPrimitive( value )

Tests if a value is a primitive string.

var bool = isString.isPrimitive( 'beep' );
// returns true

bool = isString.isPrimitive( new String( 'boop' ) );
// returns false

isString.isObject( value )

Tests if a value is a String object.

var bool = isString.isObject( 'beep' );
// returns false

bool = isString.isObject( new String( 'boop' ) );
// returns true

Examples

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

var bool = isString( 'beep' );
// returns true

bool = isString( new String( 'beep' ) );
// returns true

bool = isString( 5 );
// returns false

bool = isString( null );
// returns false

bool = isString( void 0 );
// returns false

bool = isString( {} );
// returns false

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

bool = isString( function foo() {} );
// 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.