diff --git a/lib/node_modules/@stdlib/constants/unicode/README.md b/lib/node_modules/@stdlib/constants/unicode/README.md index f13311cb1720..2df0f0070446 100644 --- a/lib/node_modules/@stdlib/constants/unicode/README.md +++ b/lib/node_modules/@stdlib/constants/unicode/README.md @@ -22,21 +22,33 @@ limitations under the License. > Unicode constants. -
- ## Usage ```javascript var constants = require( '@stdlib/constants/unicode' ); + +// Maximum Unicode code point: +console.log( 'Maximum Unicode code point:', constants.MAX ); + +// Maximum Basic Multilingual Plane (BMP) code point: +console.log( 'Maximum BMP code point:', constants.MAX_BMP ); ``` -#### constants +## constants Namespace containing Unicode constants. ```javascript -var ns = constants; -// returns {...} +var constants = require( '@stdlib/constants/unicode' ); + +function isValidBmpCharacter( char ) { + return char.codePointAt(0) <= constants.MAX_BMP; +} + +// Check if a character is within the BMP: +console.log( 'Is "𝔸" a BMP character?', isValidBmpCharacter('𝔸') ); // false +console.log( 'Is "A" a BMP character?', isValidBmpCharacter('A') ); // true + ```