Nobody Packages More

    @stdlib/regexp-whitespace
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    White Space

    NPM version Build Status Coverage Status

    Regular expression to match a white space character.

    Installation

    npm install @stdlib/regexp-whitespace

    Usage

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

    reWhitespace( [options] )

    Returns a regular expression to match a white space character.

    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. 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, set the flags option with a list of flags (which may be in any order).

    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.

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

    reWhitespace.REGEXP

    Regular expression to match a white space character.

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

    reWhitespace.REGEXP_CAPTURE

    Regular expression to capture characters matching a white space character.

    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

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

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

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

    See Also


    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/regexp-whitespace

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    89

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    53.2 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser