@stdlib/array-to-circular-iterator 0.0.2 → 0.0.6

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # circarray2iterator
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![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 repeatedly iterates over the elements of an array-like object.
 
@@ -179,10 +179,10 @@ v = it.next().value;
 
 The invoked function is provided four arguments:
 
--   `value`: iterated value
--   `index`: iterated value index
--   `n`: iteration count
--   `src`: source array-like object
+-   **value**: iterated value.
+-   **index**: iterated value index.
+-   **n**: iteration count.
+-   **src**: source array-like object.
 
 ```javascript
 function fcn( v, i ) {
@@ -246,6 +246,7 @@ var count = ctx.count;
 -   If provided a generic `array`, the returned iterator does **not** ignore holes. To achieve greater performance for sparse arrays, use a custom iterator.
 -   A returned iterator does **not** copy a provided array-like `object`. To ensure iterable reproducibility, copy a provided array-like `object` **before** creating an iterator. Otherwise, any changes to the contents of an array-like `object` will be reflected in the returned iterator.
 -   In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an array's `@@iterator` method, regardless of whether this method is defined. To convert an array to an implementation defined iterator, invoke this method directly.
+-   The returned iterator supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/complex64`][@stdlib/array/complex64]).
 
 </section>
 
@@ -301,6 +302,21 @@ while ( true ) {
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<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/array/to-strided-iterator`][@stdlib/array/to-strided-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from a strided array-like object.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -314,6 +330,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
 
 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
@@ -323,7 +343,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -342,15 +362,39 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-to-circular-iterator/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-to-circular-iterator?branch=main
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/array-to-circular-iterator
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/array-to-circular-iterator.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/array-to-circular-iterator/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/array-to-circular-iterator/tree/deno
+[umd-url]: https://github.com/stdlib-js/array-to-circular-iterator/tree/umd
+[esm-url]: https://github.com/stdlib-js/array-to-circular-iterator/tree/esm
+
+[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
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-to-circular-iterator/main/LICENSE
 
+[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64
+
+<!-- <related-links> -->
+
+[@stdlib/array/to-iterator]: https://www.npmjs.com/package/@stdlib/array-to-iterator
+
+[@stdlib/array/to-strided-iterator]: https://www.npmjs.com/package/@stdlib/array-to-strided-iterator
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/docs/types/index.d.ts

@@ -73,7 +73,7 @@ type Binary = ( value: any, index: number ) => any;
 * @param n - iteration count
 * @returns iterator value
 */
-type Tertiary = ( value: any, index: number, n: number ) => any;
+type Ternary = ( value: any, index: number, n: number ) => any;
 
 /**
 * Map function invoked for each iterated value.
@@ -95,7 +95,7 @@ type Quaternary = ( value: any, index: number, n: number, src: ArrayLike<any> )
 * @param src - source array-like object
 * @returns iterator value
 */
-type MapFunction = Nullary | Unary | Binary | Tertiary | Quaternary;
+type MapFunction = Nullary | Unary | Binary | Ternary | Quaternary;
 
 /**
 * Returns an iterator which repeatedly iterates over each element in an array-like object.

package/lib/main.js

@@ -27,6 +27,7 @@ var isCollection = require( '@stdlib/assert-is-collection' );
 var isObject = require( '@stdlib/assert-is-plain-object' );
 var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
+var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
 
 
 // MAIN //
@@ -68,6 +69,7 @@ function circarray2iterator( src ) {
 	var iter;
 	var FLG;
 	var fcn;
+	var get;
 	var i;
 	if ( !isCollection( src ) ) {
 		throw new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + src + '`.' );
@@ -131,6 +133,9 @@ function circarray2iterator( src ) {
 	if ( iteratorSymbol ) {
 		setReadOnly( iter, iteratorSymbol, factory );
 	}
+	// Resolve an accessor for retrieving array elements (e.g., to accommodate `Complex64Array`, etc):
+	get = arraylike2object( src ).getter;
+
 	return iter;
 
 	/**
@@ -148,7 +153,7 @@ function circarray2iterator( src ) {
 			};
 		}
 		return {
-			'value': fcn.call( thisArg, src[ i ], i, count, src ),
+			'value': fcn.call( thisArg, get( src, i ), i, count, src ),
 			'done': false
 		};
 	}
@@ -171,7 +176,7 @@ function circarray2iterator( src ) {
 			};
 		}
 		return {
-			'value': fcn.call( thisArg, src[ i ], i, count, src ),
+			'value': fcn.call( thisArg, get( src, i ), i, count, src ),
 			'done': false
 		};
 	}
@@ -191,7 +196,7 @@ function circarray2iterator( src ) {
 			};
 		}
 		return {
-			'value': src[ i ],
+			'value': get( src, i ),
 			'done': false
 		};
 	}
@@ -214,7 +219,7 @@ function circarray2iterator( src ) {
 			};
 		}
 		return {
-			'value': src[ i ],
+			'value': get( src, i ),
 			'done': false
 		};
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-to-circular-iterator",
-  "version": "0.0.2",
+  "version": "0.0.6",
   "description": "Create an iterator which repeatedly iterates over the elements of an array-like object.",
   "license": "Apache-2.0",
   "author": {
@@ -28,7 +28,7 @@
     "examples": "make examples",
     "benchmark": "make benchmark"
   },
-  "homepage": "https://github.com/stdlib-js/stdlib",
+  "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
     "url": "git://github.com/stdlib-js/array-to-circular-iterator.git"
@@ -37,6 +37,7 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/array-base-arraylike2object": "^0.0.x",
     "@stdlib/assert-has-own-property": "^0.0.x",
     "@stdlib/assert-is-collection": "^0.0.x",
     "@stdlib/assert-is-function": "^0.0.x",

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/array-to-circular-iterator/releases) for the changelog.