index.js (1452B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 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 UTF-16 surrogate pair. 23 * 24 * @module @stdlib/regexp/utf16-surrogate-pair 25 * 26 * @example 27 * var reUtf16SurrogatePair = require( '@stdlib/regexp/utf16-surrogate-pair' ); 28 * 29 * var RE_UTF16_SURROGATE_PAIR = reUtf16SurrogatePair(); 30 * 31 * var bool = RE_UTF16_SURROGATE_PAIR.test( '\uD800\uDC00' ); 32 * // returns true 33 * 34 * bool = RE_UTF16_SURROGATE_PAIR.test( 'abc\uD800\uDC00def' ); 35 * // returns true 36 * 37 * bool = RE_UTF16_SURROGATE_PAIR.test( 'abc' ); 38 * // returns false 39 */ 40 41 // MODULES // 42 43 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 44 var reUtf16SurrogatePair = require( './main.js' ); 45 var REGEXP = require( './regexp.js' ); 46 47 48 // MAIN // 49 50 setReadOnly( reUtf16SurrogatePair, 'REGEXP', REGEXP ); 51 52 53 // EXPORTS // 54 55 module.exports = reUtf16SurrogatePair;