Return a regular expression to match a white space character.
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we’ve built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
[Regular expression][regexp] to match a [white space][whitespace] character.
bash
npm install @stdlib/regexp-whitespace
script
tag without installation and bundlers, use the [ES Module][es-module] available on the [esm
][esm-url] branch (see [README][esm-readme]).deno
][deno-url] branch (see [README][deno-readme] for usage intructions).umd
][umd-url] branch (see [README][umd-readme]).javascript
var reWhitespace = require( '@stdlib/regexp-whitespace' );
javascript
var RE_WHITESPACE = reWhitespace();
var bool = RE_WHITESPACE.test( '\n' );
// returns true
bool = RE_WHITESPACE.test( ' ' );
// returns true
options
object with optional properties:string
specifying regular expression [flags][mdn-regexp-flags]. Default: ''
.boolean
indicating whether to create a capture group for the match. Default: false
.flags
option with a list of flags (which may be in any order).javascript
var RE_WHITESPACE = reWhitespace({
'flags': 'gm'
});
var str = 'Hello World!';
var bool = RE_WHITESPACE.test( str );
// returns true
bool = RE_WHITESPACE.test( str );
// returns false
capture
option.javascript
var RE_WHITESPACE = reWhitespace({
'capture': true
});
var str = 'Hello World!';
var arr = str.split( RE_WHITESPACE );
// returns [ 'Hello', ' ', 'World!' ]
javascript
var bool = reWhitespace.REGEXP.test( '\n' );
// returns true
bool = reWhitespace.REGEXP.test( '\\n' );
// returns false
javascript
var replace = require( '@stdlib/string-replace' );
var str = 'Duplicate capture';
var out = replace( str, reWhitespace.REGEXP_CAPTURE, '$1$1' );
// returns 'Duplicate capture'
25
characters defined as white space (“WSpace=Y”,”WS”) characters in the Unicode 9.0
character database.REGEXP
regular expression is defined astext
/[\u0009\u000A\u000B\u000C\u000D\u0020\u0085\u00A0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200A\u2028\u2029\u202F\u205F\u3000\uFEFF]/
REGEXP_CAPTURE
regular expression is defined astext
/([\u0009\u000A\u000B\u000C\u000D\u0020\u0085\u00A0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200A\u2028\u2029\u202F\u205F\u3000\uFEFF])/
javascript
var reWhitespace = require( '@stdlib/regexp-whitespace' );
var RE_WHITESPACE = reWhitespace();
var bool = RE_WHITESPACE.test( 'beep boop' );
// returns true
bool = RE_WHITESPACE.test( '\n' );
// returns true
bool = RE_WHITESPACE.test( '\r' );
// returns true
bool = RE_WHITESPACE.test( '\t' );
// returns true
bool = RE_WHITESPACE.test( 'beep' );
// returns false
var str = 'This is\na newline\r\ndelimited string.';
var arr = str.split( RE_WHITESPACE );
// returns [ 'This', 'is', 'a', 'newline', '', 'delimited', 'string.' ]