isWhitespace

Test whether a string contains only white space characters.

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