time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1933B)

      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 white space character.
     23 *
     24 * @module @stdlib/regexp/whitespace
     25 *
     26 * @example
     27 * var reWhitespace = require( '@stdlib/regexp/whitespace' );
     28 *
     29 * var RE_WHITESPACE = reWhitespace();
     30 *
     31 * var bool = RE_WHITESPACE.test( ' ' );
     32 * // returns true
     33 *
     34 * @example
     35 * var reWhitespace = require( '@stdlib/regexp/whitespace' );
     36 *
     37 * var RE_WHITESPACE = reWhitespace({
     38 *     'flags': 'gm'
     39 * });
     40 *
     41 * var bool = RE_WHITESPACE.test( '\t' );
     42 * // returns true
     43 *
     44 * @example
     45 * var RE_WHITESPACE = require( '@stdlib/regexp/whitespace' ).REGEXP;
     46 *
     47 * var bool = RE_WHITESPACE.test( 'a' );
     48 * // returns false
     49 *
     50 * @example
     51 * var RE_WHITESPACE = require( '@stdlib/regexp/whitespace' ).REGEXP_CAPTURE;
     52 * var replace = require( '@stdlib/string/replace' );
     53 *
     54 * var str = 'Duplicate capture';
     55 * var out = replace( str, RE_WHITESPACE, '$1$1' );
     56 * // returns 'Duplicate  capture'
     57 */
     58 
     59 // MODULES //
     60 
     61 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     62 var reWhitespace = require( './main.js' );
     63 var REGEXP_CAPTURE = require( './regexp_capture.js' );
     64 var REGEXP = require( './regexp.js' );
     65 
     66 
     67 // MAIN //
     68 
     69 setReadOnly( reWhitespace, 'REGEXP', REGEXP );
     70 setReadOnly( reWhitespace, 'REGEXP_CAPTURE', REGEXP_CAPTURE );
     71 
     72 
     73 // EXPORTS //
     74 
     75 module.exports = reWhitespace;