项目作者: stdlib-js

项目描述 :
Return a regular expression to match a white space character.
高级语言: JavaScript
项目地址: git://github.com/stdlib-js/regexp-whitespace.git
创建时间: 2021-06-13T19:31:27Z
项目社区:https://github.com/stdlib-js/regexp-whitespace

开源协议:Apache License 2.0

下载




About stdlib…

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!


reWhitespace

[![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.



## Installation

bash npm install @stdlib/regexp-whitespace

Alternatively,

- To load the package in a website via a script tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [deno][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [umd][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## 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'



## Notes

- Matches the 25 characters defined as white space (“WSpace=Y”,”WS”) characters in the Unicode 9.0 character database.

- Matches 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).

- The REGEXP regular expression is defined as

text /[\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]/

- The REGEXP_CAPTURE regular expression is defined as

text /([\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])/



## Examples



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.' ]



*

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

—-

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].