Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/string-to-grapheme-cluster-iterator-right

Create an iterator which iterates grapheme clusters.

https://github.com/stdlib-js/string-to-grapheme-cluster-iterator-right

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords

astral emojis grapheme iterate iteration iterator javascript node node-js nodejs segmentation stdlib str string surrogate unicode util utilities utility utils
Last synced: 6 months ago · JSON representation ·

Repository

Create an iterator which iterates grapheme clusters.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
astral emojis grapheme iterate iteration iterator javascript node node-js nodejs segmentation stdlib str string surrogate unicode util utilities utility utils
Created over 3 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

graphemeClusters2iteratorRight

NPM version Build Status Coverage Status <!-- dependencies -->

Create an iterator which iterates from right to left over grapheme clusters.

## Installation ```bash npm install @stdlib/string-to-grapheme-cluster-iterator-right ``` 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]). 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 graphemeClusters2iteratorRight = require( '@stdlib/string-to-grapheme-cluster-iterator-right' ); ``` #### graphemeClusters2iteratorRight( src\[, mapFcn\[, thisArg]] ) Returns an iterator which iterates from right to left over each [grapheme cluster][unicode-text-segmentation] in a `string`. ```javascript var iter = graphemeClusters2iteratorRight( '🌷🍕' ); var v = iter.next().value; // returns '🍕' v = iter.next().value; // returns '🌷' var bool = iter.next().done; // returns true ``` The returned iterator protocol-compliant object has the following properties: - **next**: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished. - **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object. To invoke a function for each `src` value, provide a callback function. ```javascript function fcn( v ) { return v + v; } var it = graphemeClusters2iteratorRight( 'beep', fcn ); // returns var v = it.next().value; // returns 'pp' v = it.next().value; // returns 'ee' v = it.next().value; // returns 'ee' // ... ``` The invoked function is provided three arguments: - **value**: [grapheme cluster][unicode-text-segmentation]. - **index**: iterated value index. - **src**: source string. ```javascript function fcn( v, i ) { return v + i; } var it = graphemeClusters2iteratorRight( 'bar', fcn ); // returns var v = it.next().value; // returns 'r2' v = it.next().value; // returns 'a1' v = it.next().value; // returns 'b0' // ... ``` To set the callback function execution context, provide a `thisArg`. ```javascript function fcn( v ) { this.count += 1; return v; } var ctx = { 'count': 0 }; var it = graphemeClusters2iteratorRight( '🌷🍕', fcn, ctx ); // returns var v = it.next().value; // returns '🍕' v = it.next().value; // returns '🌷' var count = ctx.count; // returns 2 ```
## Notes - If an environment supports `Symbol.iterator`, the returned iterator is iterable. - In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke a string's `@@iterator` method, regardless of whether this method is defined. To convert a string to an implementation defined iterator, invoke this method directly.
## Examples ```javascript var graphemeClusters2iteratorRight = require( '@stdlib/string-to-grapheme-cluster-iterator-right' ); function repeat( str ) { return str + str; } // Create an iterator which iterates over grapheme clusters: var it = graphemeClusters2iteratorRight( 'Iñtërnâtiônàlizætiøn', repeat ); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( v.value ); } ```
* * * ## See Also - [`@stdlib/array-to-iterator-right`][@stdlib/array/to-iterator-right]: create an iterator from an array-like object, iterating from right to left. - [`@stdlib/string-to-grapheme-cluster-iterator`][@stdlib/string/to-grapheme-cluster-iterator]: create an iterator which iterates over grapheme clusters.
* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 12
Last Year
  • Push event: 12

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 26
  • Total Committers: 1
  • Avg Commits per committer: 26.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 17
  • Committers: 1
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 26
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 4 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/string-to-grapheme-cluster-iterator-right

Create an iterator which iterates from right to left over grapheme clusters.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 2
  • Dependent Repositories: 0
  • Downloads: 4 Last month
Rankings
Dependent packages count: 9.5%
Forks count: 20.5%
Stargazers count: 22.1%
Dependent repos count: 25.3%
Average: 25.7%
Downloads: 51.2%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago