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

    0.0.6 • Public • Published

    EOL

    NPM version Build Status Coverage Status dependencies

    Regular expression to match a newline character sequence.

    Installation

    npm install @stdlib/regexp-eol

    Usage

    var reEOL = require( '@stdlib/regexp-eol' );

    reEOL( [options] )

    Returns a Regular expression to match a newline character sequence.

    var RE_EOL = reEOL();
    
    var bool = RE_EOL.test( '\n' );
    // returns true
    
    bool = RE_EOL.test( '\r\n' );
    // returns true
    
    bool = RE_EOL.test( '\\r\\n' );
    // returns false

    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 replace = require( '@stdlib/string-replace' );
    
    var RE_EOL = reEOL({
        'flags': 'g'
    });
    
    var str = '1\n2\n3';
    var out = replace( str, RE_EOL, '' );
    // returns '123'

    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_EOL = reEOL({
        'capture': true
    });
    
    var str = 'beep\nboop';
    var arr = str.split( RE_EOL );
    // returns [ 'beep', '\n', 'boop' ]

    reEOL.REGEXP

    Regular expression to match a newline character sequence.

    var bool = reEOL.REGEXP.test( 'abc' );
    // returns false

    reEOL.REGEXP_CAPTURE

    Regular expression to capture a newline character sequence.

    var parts = reEOL.REGEXP_CAPTURE.exec( '\n' );
    // returns [ '\n', '\n' ]

    Examples

    var reEOL = require( '@stdlib/regexp-eol' );
    
    var RE_EOL = reEOL();
    var bool;
    var str;
    
    bool = RE_EOL.test( '\r\n' );
    // returns true
    
    bool = RE_EOL.test( '\n' );
    // returns true
    
    bool = RE_EOL.test( '\r' );
    // returns false
    
    bool = RE_EOL.test( '\\r\\n' );
    // returns false
    
    bool = RE_EOL.test( 'beep' );
    // returns false
    
    str = 'This is\na newline\r\ndelimited string.';
    
    var arr = str.split( RE_EOL );
    // returns [ 'This is', 'a newline', 'delimited string.' ]

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/regexp-eol

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    6,744

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    45.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser