Skip to content

Latest commit

 

History

History
246 lines (145 loc) · 8.67 KB

File metadata and controls

246 lines (145 loc) · 8.67 KB
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!

nextGraphemeClusterBreak

NPM version Build Status Coverage Status

Return the next extended grapheme cluster break in a string after a specified position.

Usage

import nextGraphemeClusterBreak from 'https://cdn.jsdelivr.net/gh/stdlib-js/string-next-grapheme-cluster-break@esm/index.mjs';

nextGraphemeClusterBreak( string[, fromIndex] )

Returns the next extended grapheme cluster break in a string after a specified position.

var out = nextGraphemeClusterBreak( 'last man standing' );
// returns 1

By default, the function searches for a grapheme cluster break starting from the first index. To specify an alternative starting search index, provide a fromIndex argument.

var out = nextGraphemeClusterBreak( 'last man standing', 4 );
// returns 5

Notes

  • If string is an empty string, the function returns -1 irrespective of fromIndex.
  • If an extended grapheme cluster break does not exist after fromIndex, the function returns -1.
  • Note that fromIndex does not refer to a visual character position, but to an index in the ordered sequence of UTF-16 code units.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

import nextGraphemeClusterBreak from 'https://cdn.jsdelivr.net/gh/stdlib-js/string-next-grapheme-cluster-break@esm/index.mjs';

var out = nextGraphemeClusterBreak( 'last man standing', 4 );
// returns 5

out = nextGraphemeClusterBreak( 'presidential election', 8 );
// returns 9

out = nextGraphemeClusterBreak( 'अनुच्छेद', 1 );
// returns 3

out = nextGraphemeClusterBreak( '🌷', 0 );
// returns -1

</script>
</body>
</html>

See Also


Notice

This package is part of stdlib, a standard library 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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.