@stdlib/string-prev-grapheme-cluster-break
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

prevGraphemeClusterBreak

NPM version Build Status Coverage Status

Return the previous extended grapheme cluster break in a string before a specified position.

Installation

npm install @stdlib/string-prev-grapheme-cluster-break

Usage

var prevGraphemeClusterBreak = require( '@stdlib/string-prev-grapheme-cluster-break' );

prevGraphemeClusterBreak( string[, fromIndex] )

Returns the previous extended grapheme cluster break in a string before a specified position.

var out = prevGraphemeClusterBreak( 'last man standing' );
// returns 15

By default, the last extended grapheme cluster break in the string is returned. For the previous extended grapheme cluster break before a specified position in the string, provide a fromIndex.

var out = prevGraphemeClusterBreak( 'last man standing', 4 );
// returns 3

Notes

  • If string is an empty string, the function returns -1 irrespective of fromIndex.
  • If there is no extended grapheme cluster break before 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

var prevGraphemeClusterBreak = require( '@stdlib/string-prev-grapheme-cluster-break' );

console.log( prevGraphemeClusterBreak( 'last man standing', 4 ) );
// => 3

console.log( prevGraphemeClusterBreak( 'presidential election', 8 ) );
// => 7

console.log( prevGraphemeClusterBreak( 'अनुच्छेद', 2 ) );
// => 0

console.log( prevGraphemeClusterBreak( '🌷', 1 ) );
// => -1

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/string-prev-grapheme-cluster-break

Homepage

stdlib.io

Weekly Downloads

40

Version

0.2.1

License

Apache-2.0

Unpacked Size

35.1 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser