Package Exports
- @stdlib/string-tools-grapheme-cluster-break
- @stdlib/string-tools-grapheme-cluster-break/dist
- @stdlib/string-tools-grapheme-cluster-break/dist/index.js
- @stdlib/string-tools-grapheme-cluster-break/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-tools-grapheme-cluster-break) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
About stdlib...
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
Grapheme cluster break tooling.
Installation
npm install @stdlib/string-tools-grapheme-cluster-breakUsage
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.
var out = grapheme.breakProperty( 0x008f );
// returns 2
out = grapheme.breakProperty( 0x111C2 );
// returns 12
out = grapheme.breakProperty( 0x1F3FC );
// returns 3grapheme.emojiProperty( code )
Returns the emoji property from the Unicode Standard.
var out = grapheme.emojiProperty( 0x23EC );
// returns 101
out = grapheme.emojiProperty( 0x1FFFE );
// returns 11grapheme.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.
var out = grapheme.breakType( [ 11, 3, 11 ], [ 11, 11, 11 ] );
// returns 1Properties
grapheme.constants
An object mapping break type names to integer values.
var out = grapheme.constants;
// returns {...}Examples
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 {...}Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.