Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xotic750/is-surrogate-pair-x
Tests if 2 characters together are a surrogate pair.
https://github.com/xotic750/is-surrogate-pair-x
browser ecmascript nodejs string surrogate utf16
Last synced: 2 months ago
JSON representation
Tests if 2 characters together are a surrogate pair.
- Host: GitHub
- URL: https://github.com/xotic750/is-surrogate-pair-x
- Owner: Xotic750
- License: mit
- Created: 2015-11-26T00:20:30.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:52:06.000Z (about 2 years ago)
- Last Synced: 2024-11-14T10:37:24.980Z (2 months ago)
- Topics: browser, ecmascript, nodejs, string, surrogate, utf16
- Language: JavaScript
- Homepage:
- Size: 2.4 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## is-surrogate-pair-x
Tests if 2 characters together are a surrogate pair.
### `module.exports(char1, [char2])` ⇒ boolean ⏏
Tests if the two character arguments combined are a valid UTF-16
surrogate pair.
**Kind**: Exported function
**Returns**: boolean - Returns true if the two characters create a valid
'UTF-16' surrogate pair; otherwise false.
| Param | Type | Description |
| ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
| char1 | \* | The character combination, or if `char2` is supplied then the first character of a suspected surrogate pair. |
| [char2] | \* | The second character of a suspected surrogate pair. |
**Example**
```js
import isSurrogatePair from 'is-surrogate-pair-x';
const test1 = 'a';
const test2 = '𠮟';
console.log(isSurrogatePair(test1)); // false
console.log(isSurrogatePair(test1.charAt(0), test1.charAt(1))); // false
console.log(isSurrogatePair(test2)); // true
console.log(isSurrogatePair(test2.charAt(0), test2.charAt(1))); // true
```