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

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

@@ -0,0 +1 @@
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -0,0 +1,289 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2022 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# graphemeClusters2iterator
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Create an iterator which iterates over [grapheme clusters][unicode-text-segmentation].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/string-to-grapheme-cluster-iterator
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var graphemeClusters2iterator = require( '@stdlib/string-to-grapheme-cluster-iterator' );
+```
+
+#### graphemeClusters2iterator( src\[, mapFcn\[, thisArg]] )
+
+Returns an iterator which iterates over each [grapheme cluster][unicode-text-segmentation] in a `string`.
+
+```javascript
+var iter = graphemeClusters2iterator( '🌷🍕' );
+
+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 = graphemeClusters2iterator( 'beep', fcn );
+// returns <Object>
+
+var v = it.next().value;
+// returns 'bb'
+
+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 = graphemeClusters2iterator( 'bar', fcn );
+// returns <Object>
+
+var v = it.next().value;
+// returns 'b0'
+
+v = it.next().value;
+// returns 'a1'
+
+v = it.next().value;
+// returns 'r2'
+
+// ...
+```
+
+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 = graphemeClusters2iterator( '🌷🍕', fcn, ctx );
+// returns <Object>
+
+var v = it.next().value;
+// returns '🌷'
+
+v = it.next().value;
+// returns '🍕'
+
+var count = ctx.count;
+// returns 2
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## 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.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var graphemeClusters2iterator = require( '@stdlib/string-to-grapheme-cluster-iterator' );
+
+function repeat( str ) {
+    return str + str;
+}
+
+// Create an iterator which iterates over grapheme clusters:
+var it = graphemeClusters2iterator( '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 );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<section class="main-repo" >
+
+* * *
+
+## 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 &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+
+</section>
+
+<!-- /.stdlib -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[npm-image]: http://img.shields.io/npm/v/@stdlib/string-to-grapheme-cluster-iterator.svg
+[npm-url]: https://npmjs.org/package/@stdlib/string-to-grapheme-cluster-iterator
+
+[test-image]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/actions/workflows/test.yml/badge.svg?branch=v0.0.1
+[test-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/actions/workflows/test.yml?query=branch:v0.0.1
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-to-grapheme-cluster-iterator/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/string-to-grapheme-cluster-iterator?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/string-to-grapheme-cluster-iterator.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/string-to-grapheme-cluster-iterator/main
+
+-->
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://gitter.im/stdlib-js/stdlib/
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[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-to-grapheme-cluster-iterator/tree/deno
+[umd-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/tree/umd
+[esm-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/tree/esm
+[branches-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/blob/main/branches.md
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-to-grapheme-cluster-iterator/main/LICENSE
+
+[unicode-text-segmentation]: http://www.unicode.org/reports/tr29/
+
+</section>
+
+<!-- /.links -->

package/docs/repl.txt

@@ -0,0 +1,55 @@
+
+{{alias}}( src[, mapFcn[, thisArg]] )
+    Returns an iterator which iterates over each grapheme cluster in a string.
+
+    When invoked, an input function is provided three arguments:
+
+    - value: grapheme cluster
+    - index: iterated value index
+    - src: source string
+
+    If an environment supports Symbol.iterator, the returned iterator is
+    iterable.
+
+    If an environment supports 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.
+
+    Parameters
+    ----------
+    src: string
+        String from which to create the iterator.
+
+    mapFcn: Function (optional)
+        Function to invoke for each iterated value.
+
+    thisArg: any (optional)
+        Execution context.
+
+    Returns
+    -------
+    iterator: Object
+        Iterator.
+
+    iterator.next(): Function
+        Returns an iterator protocol-compliant object containing the next
+        iterated value (if one exists) and a boolean flag indicating whether the
+        iterator is finished.
+
+    iterator.return( [value] ): Function
+        Finishes an iterator and returns a provided value.
+
+    Examples
+    --------
+    > var it = {{alias}}( '🌷🍕' );
+    > var v = it.next().value
+    '🌷'
+    > v = it.next().value
+    '🍕'
+    > var bool = it.next().done
+    true
+
+    See Also
+    --------
+

package/docs/types/index.d.ts

@@ -0,0 +1,97 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+
+// Define a union type representing both iterable and non-iterable iterators:
+type Iterator = Iter | IterableIterator;
+
+/**
+* Map function invoked for each iterated value.
+*
+* @returns iterator value
+*/
+type Nullary = () => any;
+
+/**
+* Map function invoked for each iterated value.
+*
+* @param value - iterated value
+* @returns iterator value
+*/
+type Unary = ( value: string ) => any;
+
+/**
+* Map function invoked for each iterated value.
+*
+* @param value - iterated value
+* @param index - iterated value index
+* @returns iterator value
+*/
+type Binary = ( value: string, index: number ) => any;
+
+/**
+* Map function invoked for each iterated value.
+*
+* @param value - iterated value
+* @param index - iterated value index
+* @param src - source string
+* @returns iterator value
+*/
+type Ternary = ( value: string, index: number, src: string ) => any;
+
+/**
+* Map function invoked for each iterated value.
+*
+* @param value - iterated value
+* @param index - iterated value index
+* @param src - source string
+* @returns iterator value
+*/
+type MapFunction = Nullary | Unary | Binary | Ternary;
+
+/**
+* Returns an iterator which iterates over each grapheme cluster in a string.
+*
+* @param src - input value
+* @param mapFc - function to invoke for each iterated value
+* @param thisArg - execution context
+* @returns iterator
+*
+* @example
+* var iter = graphemeClusters2iterator( '🌷🍕' );
+*
+* var v = iter.next().value;
+* // returns '🌷'
+*
+* v = iter.next().value;
+* // returns '🍕'
+*
+* var bool = iter.next().done;
+* // returns true
+*/
+declare function graphemeClusters2iterator( src: string, mapFcn?: MapFunction, thisArg?: any ): Iterator; // tslint:disable-line:max-line-length
+
+
+// EXPORTS //
+
+export = graphemeClusters2iterator;

package/docs/types/test.ts

@@ -0,0 +1,66 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import graphemeClusters2iterator = require( './index' );
+
+/**
+* Transforms a string.
+*
+* @param v - iterated value
+* @returns new value
+*/
+function transform( v: string ): string {
+	return v + v;
+}
+
+
+// TESTS //
+
+// The function returns an iterator...
+{
+	graphemeClusters2iterator( 'beep' ); // $ExpectType Iterator
+	graphemeClusters2iterator( 'beep', transform ); // $ExpectType Iterator
+	graphemeClusters2iterator( 'beep', transform, {} ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a string...
+{
+	graphemeClusters2iterator( 123 );  // $ExpectError
+	graphemeClusters2iterator( true ); // $ExpectError
+	graphemeClusters2iterator( false ); // $ExpectError
+	graphemeClusters2iterator( {} ); // $ExpectError
+	graphemeClusters2iterator( null ); // $ExpectError
+	graphemeClusters2iterator( undefined ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a map function...
+{
+	graphemeClusters2iterator( 'beep', 'abc' ); // $ExpectError
+	graphemeClusters2iterator( 'beep', 123 ); // $ExpectError
+	graphemeClusters2iterator( 'beep', [] ); // $ExpectError
+	graphemeClusters2iterator( 'beep', {} ); // $ExpectError
+	graphemeClusters2iterator( 'beep', true ); // $ExpectError
+	graphemeClusters2iterator( 'beep', false ); // $ExpectError
+	graphemeClusters2iterator( 'beep', null ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	graphemeClusters2iterator(); // $ExpectError
+	graphemeClusters2iterator( 'beep', transform, {}, 123 ); // $ExpectError
+}

package/lib/index.js

@@ -0,0 +1,48 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/**
+* Create an iterator which iterates over grapheme clusters.
+*
+* @module @stdlib/string-to-grapheme-cluster-iterator
+*
+* @example
+* var graphemeClusters2iterator = require( '@stdlib/string-to-grapheme-cluster-iterator' );
+*
+* var iter = graphemeClusters2iterator( '🌷🍕' );
+*
+* var v = iter.next().value;
+* // returns '🌷'
+*
+* v = iter.next().value;
+* // returns '🍕'
+*
+* var bool = iter.next().done;
+* // returns true
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,195 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var isFunction = require( '@stdlib/assert-is-function' );
+var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var iteratorSymbol = require( '@stdlib/symbol-iterator' );
+var nextGraphemeClusterBreak = require( '@stdlib/string-next-grapheme-cluster-break' );
+var format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Returns an iterator which iterates over each grapheme cluster in a string.
+*
+* @param {string} src - input value
+* @param {Function} [mapFcn] - function to invoke for each iterated value
+* @param {*} [thisArg] - execution context
+* @throws {TypeError} first argument must be a string
+* @throws {TypeError} second argument must be a function
+* @returns {Iterator} iterator
+*
+* @example
+* var iter = graphemeClusters2iterator( '🌷🍕' );
+*
+* var v = iter.next().value;
+* // returns '🌷'
+*
+* v = iter.next().value;
+* // returns '🍕'
+*
+* var bool = iter.next().done;
+* // returns true
+*/
+function graphemeClusters2iterator( src ) {
+	var thisArg;
+	var iter;
+	var FLG;
+	var fcn;
+	var i;
+	if ( !isString( src ) ) {
+		throw new TypeError( format( 'invalid argument. First argument must be astring. Value: `%s`.', src ) );
+	}
+	if ( arguments.length > 1 ) {
+		fcn = arguments[ 1 ];
+		if ( !isFunction( fcn ) ) {
+			throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fcn ) );
+		}
+		thisArg = arguments[ 2 ];
+	}
+	i = 0;
+
+	// Create an iterator protocol-compliant object:
+	iter = {};
+	if ( fcn ) {
+		setReadOnly( iter, 'next', next1 );
+	} else {
+		setReadOnly( iter, 'next', next2 );
+	}
+	setReadOnly( iter, 'return', end );
+
+	// If an environment supports `Symbol.iterator`, make the iterator iterable:
+	if ( iteratorSymbol ) {
+		setReadOnly( iter, iteratorSymbol, factory );
+	}
+	return iter;
+
+	/**
+	* Returns an iterator protocol-compliant object containing the next iterated value.
+	*
+	* @private
+	* @returns {Object} iterator protocol-compliant object
+	*/
+	function next1() {
+		var v;
+		var j;
+		if ( FLG ) {
+			return {
+				'done': true
+			};
+		}
+		j = nextGraphemeClusterBreak( src, i );
+		if ( j === -1 ) {
+			FLG = true;
+			if ( src.length ) {
+				return {
+					'value': fcn.call( thisArg, src.substring( i ), i, src ),
+					'done': false
+				};
+			}
+			return {
+				'done': true
+			};
+		}
+		v = fcn.call( thisArg, src.substring( i, j ), i, src );
+		i = j;
+		return {
+			'value': v,
+			'done': false
+		};
+	}
+
+	/**
+	* Returns an iterator protocol-compliant object containing the next iterated value.
+	*
+	* @private
+	* @returns {Object} iterator protocol-compliant object
+	*/
+	function next2() {
+		var v;
+		var j;
+		if ( FLG ) {
+			return {
+				'done': true
+			};
+		}
+		j = nextGraphemeClusterBreak( src, i );
+		if ( j === -1 ) {
+			FLG = true;
+			if ( src.length ) {
+				return {
+					'value': src.substring( i ),
+					'done': false
+				};
+			}
+			return {
+				'done': true
+			};
+		}
+		v = src.substring( i, j );
+		i = j;
+		return {
+			'value': v,
+			'done': false
+		};
+	}
+
+	/**
+	* Finishes an iterator.
+	*
+	* @private
+	* @param {*} [value] - value to return
+	* @returns {Object} iterator protocol-compliant object
+	*/
+	function end( value ) {
+		FLG = true;
+		if ( arguments.length ) {
+			return {
+				'value': value,
+				'done': true
+			};
+		}
+		return {
+			'done': true
+		};
+	}
+
+	/**
+	* Returns a new iterator.
+	*
+	* @private
+	* @returns {Iterator} iterator
+	*/
+	function factory() {
+		if ( fcn ) {
+			return graphemeClusters2iterator( src, fcn, thisArg );
+		}
+		return graphemeClusters2iterator( src );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = graphemeClusters2iterator;

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@stdlib/string-to-grapheme-cluster-iterator",
+  "version": "0.0.1",
+  "description": "Create an iterator which iterates grapheme clusters.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "benchmark": "./benchmark",
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {
+    "test": "make test",
+    "test-cov": "make test-cov",
+    "examples": "make examples",
+    "benchmark": "make benchmark"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/string-to-grapheme-cluster-iterator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/assert-is-function": "^0.0.x",
+    "@stdlib/assert-is-string": "^0.0.x",
+    "@stdlib/string-format": "^0.0.x",
+    "@stdlib/string-next-grapheme-cluster-break": "^0.0.x",
+    "@stdlib/symbol-iterator": "^0.0.x",
+    "@stdlib/types": "^0.0.x",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+  },
+  "devDependencies": {
+    "@stdlib/assert-is-iterator-like": "^0.0.x",
+    "@stdlib/bench": "^0.0.x",
+    "@stdlib/string-num-grapheme-clusters": "^0.0.x",
+    "@stdlib/utils-noop": "^0.0.x",
+    "proxyquire": "^2.0.0",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdstring",
+    "utilities",
+    "utility",
+    "utils",
+    "util",
+    "string",
+    "str",
+    "unicode",
+    "grapheme",
+    "segmentation",
+    "surrogate",
+    "astral",
+    "emojis",
+    "iterator",
+    "iterate",
+    "iteration",
+    "iter",
+    "to",
+    "convert"
+  ],
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/athan"
+  }
+}