Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/string-prev-grapheme-cluster-break
Return the previous extended grapheme cluster break in a string before a specified position.
https://github.com/stdlib-js/string-prev-grapheme-cluster-break
astral code grapheme javascript node node-js nodejs point pt stdlib str string surrogate unicode utf-16 utf16 util utilities utility utils
Last synced: 3 months ago
JSON representation
Return the previous extended grapheme cluster break in a string before a specified position.
- Host: GitHub
- URL: https://github.com/stdlib-js/string-prev-grapheme-cluster-break
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-10-09T16:59:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T08:05:39.000Z (4 months ago)
- Last Synced: 2024-10-13T18:41:35.826Z (4 months ago)
- Topics: astral, code, grapheme, javascript, node, node-js, nodejs, point, pt, stdlib, str, string, surrogate, unicode, utf-16, utf16, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.17 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
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!
# prevGraphemeClusterBreak
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the previous extended grapheme cluster break in a string before a specified position.
## Installation
```bash
npm install @stdlib/string-prev-grapheme-cluster-break
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
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.
```javascript
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`.
```javascript
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][utf-16] code units.
## Examples
```javascript
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
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/string-prev-grapheme-cluster-break-cli
```
### Usage
```text
Usage: prev-grapheme-cluster-break [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
--fromIndex index Position in string. Default: string.length-1.
```
### Examples
```bash
$ prev-grapheme-cluster-break --fromIndex=2 अनुच्छेद
0
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'अनुच्छेद' | prev-grapheme-cluster-break --fromIndex=2
0
```
* * *
## See Also
- [`@stdlib/string-num-grapheme-clusters`][@stdlib/string/num-grapheme-clusters]: return the number of grapheme clusters in a string.
- [`@stdlib/string-next-grapheme-cluster-break`][@stdlib/string/next-grapheme-cluster-break]: return the next extended grapheme cluster break in a string after a specified position.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-prev-grapheme-cluster-break.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-prev-grapheme-cluster-break
[test-image]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-prev-grapheme-cluster-break/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-prev-grapheme-cluster-break?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break#cli
[cli-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/tree/cli
[@stdlib/string-prev-grapheme-cluster-break]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-prev-grapheme-cluster-break/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-prev-grapheme-cluster-break/main/LICENSE
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[utf-16]: https://en.wikipedia.org/wiki/UTF-16
[@stdlib/string/num-grapheme-clusters]: https://github.com/stdlib-js/string-num-grapheme-clusters
[@stdlib/string/next-grapheme-cluster-break]: https://github.com/stdlib-js/string-next-grapheme-cluster-break