@stdlib/string-to-grapheme-cluster-iterator 0.1.0 → 0.1.1

package/NOTICE

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

package/README.md

@@ -220,6 +220,13 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array-to-iterator`][@stdlib/array/to-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object.</span>
+-   <span class="package-name">[`@stdlib/string-to-grapheme-cluster-iterator-right`][@stdlib/string/to-grapheme-cluster-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates from right to left over grapheme clusters.</span>
+
 </section>
 
 <!-- /.related -->
@@ -250,7 +257,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -263,8 +270,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [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.1.0
-[test-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/actions/workflows/test.yml?query=branch:v0.1.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
@@ -287,14 +294,25 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [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
+[deno-readme]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/tree/umd
+[umd-readme]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/tree/esm
+[esm-readme]: https://github.com/stdlib-js/string-to-grapheme-cluster-iterator/blob/esm/README.md
 [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/
 
+<!-- <related-links> -->
+
+[@stdlib/array/to-iterator]: https://www.npmjs.com/package/@stdlib/array-to-iterator
+
+[@stdlib/string/to-grapheme-cluster-iterator-right]: https://www.npmjs.com/package/@stdlib/string-to-grapheme-cluster-iterator-right
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/docs/types/index.d.ts

@@ -89,7 +89,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary;
 * var bool = iter.next().done;
 * // returns true
 */
-declare function graphemeClusters2iterator( src: string, mapFcn?: MapFunction, thisArg?: any ): Iterator; // tslint:disable-line:max-line-length
+declare function graphemeClusters2iterator( src: string, mapFcn?: MapFunction, thisArg?: any ): Iterator;
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-to-grapheme-cluster-iterator",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create an iterator which iterates over grapheme clusters.",
   "license": "Apache-2.0",
   "author": {
@@ -15,19 +15,12 @@
   ],
   "main": "./lib",
   "directories": {
-    "benchmark": "./benchmark",
     "doc": "./docs",
-    "example": "./examples",
     "lib": "./lib",
-    "test": "./test"
+    "dist": "./dist"
   },
   "types": "./docs/types",
-  "scripts": {
-    "test": "make test",
-    "test-cov": "make test-cov",
-    "examples": "make examples",
-    "benchmark": "make benchmark"
-  },
+  "scripts": {},
   "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
@@ -37,25 +30,14 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-function": "^0.1.0",
-    "@stdlib/assert-is-string": "^0.1.0",
-    "@stdlib/string-format": "^0.1.0",
-    "@stdlib/string-next-grapheme-cluster-break": "^0.1.0",
-    "@stdlib/symbol-iterator": "^0.1.0",
-    "@stdlib/types": "^0.1.0",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
-    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
-  },
-  "devDependencies": {
-    "@stdlib/assert-is-iterator-like": "^0.1.0",
-    "@stdlib/bench": "^0.1.0",
-    "@stdlib/string-num-grapheme-clusters": "^0.0.9",
-    "@stdlib/utils-noop": "^0.1.0",
-    "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"
+    "@stdlib/assert-is-function": "^0.2.1",
+    "@stdlib/assert-is-string": "^0.2.1",
+    "@stdlib/string-format": "^0.2.1",
+    "@stdlib/string-next-grapheme-cluster-break": "^0.2.1",
+    "@stdlib/symbol-iterator": "^0.2.1",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1"
   },
+  "devDependencies": {},
   "engines": {
     "node": ">=0.10.0",
     "npm": ">2.7.0"

package/CITATION.cff

@@ -1,30 +0,0 @@
-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