index.js (1817B)
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 * Return a regular expression to match a decimal number. 23 * 24 * @module @stdlib/regexp/decimal-number 25 * 26 * @example 27 * var reDecimalNumber = require( '@stdlib/regexp/decimal-number' ); 28 * 29 * var RE_DECIMAL_NUMBER = reDecimalNumber(); 30 * 31 * var bool = RE_DECIMAL_NUMBER.test( 'beep 1.0 boop' ); 32 * // returns true 33 * 34 * bool = RE_DECIMAL_NUMBER.test( 'beep 1 boop' ); 35 * // returns false 36 * 37 * @example 38 * var reDecimalNumber = require( '@stdlib/regexp/decimal-number' ); 39 * 40 * var RE_DECIMAL_NUMBER = reDecimalNumber({ 41 * 'flags': 'gm' 42 * }); 43 * var bool = RE_DECIMAL_NUMBER.test( 'beep 1.0 boop' ); 44 * // returns true 45 * 46 * @example 47 * var reDecimalNumber = require( '@stdlib/regexp/decimal-number' ); 48 * 49 * var bool = reDecimalNumber.REGEXP.test( '2:3' ); 50 * // returns false 51 */ 52 53 // MODULES // 54 55 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 56 var reDecimalNumber = require( './main.js' ); 57 var REGEXP_CAPTURE = require( './regexp_capture.js' ); 58 var REGEXP = require( './regexp.js' ); 59 60 61 // MAIN // 62 63 setReadOnly( reDecimalNumber, 'REGEXP', REGEXP ); 64 setReadOnly( reDecimalNumber, 'REGEXP_CAPTURE', REGEXP_CAPTURE ); 65 66 67 // EXPORTS // 68 69 module.exports = reDecimalNumber;