is-surrogate-pair-x

is-surrogate-pair-x

Tests if 2 characters together are a surrogate pair.

Version: 1.4.0
Author: Xotic750 [e-mail]
License: MIT
Copyright: Xotic750

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 first character of a suspected surrogate pair.
char2	*	The second character of a suspected surrogate pair.

Example

var isSurrogatePair = require('is-surrogate-pair-x');

var test1 = 'a';
var test2 = '𠮟';

isSurrogatePair(test1.charAt(0), test1.charAt(1)); // false
isSurrogatePair(test2.charAt(0), test2.charAt(1)); // true