Return a regular expression to match a UTF-16 surrogate pair.
npm install @stdlib/regexp-utf16-surrogate-pairWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Regular expression][mdn-regexp] to match a [UTF-16][utf-16] surrogate pair.
``bash`
npm install @stdlib/regexp-utf16-surrogate-pair
`javascript`
var reUtf16SurrogatePair = require( '@stdlib/regexp-utf16-surrogate-pair' );
#### reUtf16SurrogatePair()
Returns a [regular expression][mdn-regexp] to match a [UTF-16][utf-16] surrogate pair.
`javascript
var RE_UTF16_SURROGATE_PAIR = reUtf16SurrogatePair();
var bool = RE_UTF16_SURROGATE_PAIR.test( 'abc\uD800\uDC00def' );
// returns true
`
#### reUtf16SurrogatePair.REGEXP
[Regular expression][mdn-regexp] to match a [UTF-16][utf-16] surrogate pair.
`javascript`
var bool = reUtf16SurrogatePair.REGEXP.test( 'abc\uD800\uDC00def' );
// returns true
`javascript
var reUtf16SurrogatePair = require( '@stdlib/regexp-utf16-surrogate-pair' );
var RE_UTF16_SURROGATE_PAIR = reUtf16SurrogatePair();
var bool = RE_UTF16_SURROGATE_PAIR.test( '\uD800\uDC00' );
// returns true
bool = RE_UTF16_SURROGATE_PAIR.test( 'abc\uD800\uDC00def' );
// returns true
bool = RE_UTF16_SURROGATE_PAIR.test( 'abc' );
// returns false
`
*
- [@stdlib/regexp-utf16-unpaired-surrogate][@stdlib/regexp/utf16-unpaired-surrogate]: return a regular expression to match an unpaired UTF-16 surrogate.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/regexp-utf16-surrogate-pair.svg
[npm-url]: https://npmjs.org/package/@stdlib/regexp-utf16-surrogate-pair
[test-image]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/regexp-utf16-surrogate-pair/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/regexp-utf16-surrogate-pair?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/tree/deno
[deno-readme]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/tree/umd
[umd-readme]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/tree/esm
[esm-readme]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/regexp-utf16-surrogate-pair/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/regexp-utf16-surrogate-pair/main/LICENSE
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[utf-16]: https://en.wikipedia.org/wiki/UTF-16
[@stdlib/regexp/utf16-unpaired-surrogate]: https://www.npmjs.com/package/@stdlib/regexp-utf16-unpaired-surrogate