isWhitespace

Test whether a string contains only white space characters.

Installation

npm install @stdlib/assert-is-whitespace

Usage

var isWhitespace = require( '@stdlib/assert-is-whitespace' );

isWhitespace( value )

Tests whether a string contains only white space characters.

var bool = isWhitespace( '             ' );
// returns true

Notes

• A white space character is defined as one of the 25 characters defined as a white space ("WSpace=Y","WS") character in the Unicode 9.0 character database, as well as one related white space character without the Unicode character property "WSpace=Y" (zero width non-breaking space which was deprecated as of Unicode 3.2).
• For non-string values, the function returns false.

Examples

var isWhitespace = require( '@stdlib/assert-is-whitespace' );

var out = isWhitespace( '              ' );
// returns true

out = isWhitespace( '' );
// returns false

out = isWhitespace( '\\r\\n' );
// returns false

out = isWhitespace( 123 );
// returns false

See Also

• @stdlib/assert-is-whitespace-cli: CLI package for use as a command-line utility.
• @stdlib/regexp-whitespace: return a regular expression to match a white space character.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.