stdlib-js
<summary>
About stdlib...
</summary>
We 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!
grapheme
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Grapheme cluster break tooling.
bash
npm install @stdlib/string-tools-grapheme-cluster-break
javascript
var grapheme = require( '@stdlib/string-tools-grapheme-cluster-break' );
#### grapheme
A collection of functions for performing grapheme cluster break operations.
### Methods
#### grapheme.breakProperty( code )
Returns the grapheme break property from the [Unicode Standard][unicode-grapheme-break-property].
javascript
var out = grapheme.breakProperty( 0x008f );
// returns 2
out = grapheme.breakProperty( 0x111C2 );
// returns 12
out = grapheme.breakProperty( 0x1F3FC );
// returns 3
#### grapheme.emojiProperty( code )
Returns the emoji property from the [Unicode Standard][unicode-emoji-property].
javascript
var out = grapheme.emojiProperty( 0x23EC );
// returns 101
out = grapheme.emojiProperty( 0x1FFFE );
// returns 11
#### grapheme.breakType( breaks, emoji )
Returns the break type between grapheme breaking classes according to UAX #29 3.1.1 Grapheme Cluster Boundary Rules on extended grapheme clusters.
javascript
var out = grapheme.breakType( [ 11, 3, 11 ], [ 11, 11, 11 ] );
// returns 1
### Properties
#### grapheme.constants
An object mapping break type names to integer values.
javascript
var out = grapheme.constants;
// returns {...}
javascript
var grapheme = require( '@stdlib/string-tools-grapheme-cluster-break' );
var out = grapheme.breakProperty( 0x008f );
// returns 2
out = grapheme.emojiProperty( 0x23EC );
// returns 101
out = grapheme.breakType( [ 11, 3, 11 ], [ 11, 11, 11 ] );
// returns 1
out = grapheme.constants;
// returns {...}
