8000 GitHub - stdlib-js/assert-is-string at 2db5d8f5a9bc03bc89a550a2cf649d8618a0d4e1
[go: up one dir, main page]

Skip to content

stdlib-js/assert-is-string

Repository files navigation

isString

NPM version Build Status Coverage Status

Test if a value is a string.

Installation

npm install @stdlib/assert-is-string

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

0