Usage

`javascript
var reWhitespace = require( '@stdlib/regexp-whitespace' );
`

#### reWhitespace( \[options] )

Returns a [regular expression][regexp] to match a [white space][whitespace] character.

`javascript
var RE_WHITESPACE = reWhitespace();

var bool = RE_WHITESPACE.test( '\n' );
// returns true

bool = RE_WHITESPACE.test( ' ' );
// returns true
`

The function accepts an options object with optional properties:

- flags: string specifying regular expression [flags][mdn-regexp-flags]. Default: ''.
- capture: boolean indicating whether to create a capture group for the match. Default: false.

By default, the function returns a regular expression which does not have any flags specified. To specify [flags][mdn-regexp-flags], set the 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
`

By default, the function returns a regular expression which does not capture the part of a string matching the regular expression. To capture matches, set the capture option.

`javascript
var RE_WHITESPACE = reWhitespace({
'capture': true
});
var str = 'Hello World!';
var arr = str.split( RE_WHITESPACE );
// returns [ 'Hello', ' ', 'World!' ]
`

#### reWhitespace.REGEXP

[Regular expression][regexp] to match a [white space][whitespace] character.

`javascript
var bool = reWhitespace.REGEXP.test( '\n' );
// returns true

bool = reWhitespace.REGEXP.test( '\\n' );
// returns false
`

#### reWhitespace.REGEXP_CAPTURE

[Regular expression][regexp] to capture characters matching a [white space][whitespace] character.

`javascript
var replace = require( '@stdlib/string-replace' );

var str = 'Duplicate capture';
var out = replace( str, reWhitespace.REGEXP_CAPTURE, '$1$1' );
// returns 'Duplicate capture'
`