index.js (1653B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Regular expression to match a newline character sequence. 23 * 24 * @module @stdlib/regexp/eol 25 * 26 * @example 27 * var reEOL = require( '@stdlib/regexp/eol' ); 28 * var RE_EOL = reEOL(); 29 * 30 * var bool = RE_EOL.test( '\n' ); 31 * // returns true 32 * 33 * bool = RE_EOL.test( '\\r\\n' ); 34 * // returns false 35 * 36 * @example 37 * var reEOL = require( '@stdlib/regexp/eol' ); 38 * var replace = require( '@stdlib/string/replace' ); 39 * 40 * var RE_EOL = reEOL({ 41 * 'flags': 'g' 42 * }); 43 * var str = '1\n2\n3'; 44 * var out = replace( str, RE_EOL, '' ); 45 * 46 * @example 47 * var reEOL = require( '@stdlib/regexp/eol' ); 48 * var bool = reEOL.REGEXP.test( '\r\n' ); 49 * // returns true 50 */ 51 52 // MODULES // 53 54 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 55 var reEOL = require( './main.js' ); 56 var REGEXP_CAPTURE = require( './regexp_capture.js' ); 57 var REGEXP = require( './regexp.js' ); 58 59 60 // MAIN // 61 62 setReadOnly( reEOL, 'REGEXP', REGEXP ); 63 setReadOnly( reEOL, 'REGEXP_CAPTURE', REGEXP_CAPTURE ); 64 65 66 // EXPORTS // 67 68 module.exports = reEOL;