@stdlib/console-log-each 0.0.1 → 0.1.0

package/CITATION.cff

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

package/NOTICE

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

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>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.</p>
+  <p>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.</p>
+  <p>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.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # logEach
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -64,7 +75,7 @@ logEach( '%d < %d ', x, y );
 // e.g., => '1 < 4\n2 < 5\n3 < 6\n'
 ```
 
-If an interpolated argument is not a collection, the argument is broadcasted for each iteration.
+If an interpolated argument is not an array-like object, the argument is broadcasted for each iteration.
 
 ```javascript
 var x = [ 1, 2, 3 ];
@@ -84,7 +95,8 @@ logEach( '%d < %d', x, y );
 
 ## Notes
 
--   If the function is provided collections of unequal lengths, the function throws an error.
+-   If the function is provided array-like objects of unequal lengths, the function throws an error.
+-   The function supports array-like objects supporting the accessor protocol (e.g., [`Complex128Array`][@stdlib/array/complex128], [`Complex64Array`][@stdlib/array/complex64], etc).
 
 </section>
 
@@ -159,7 +171,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -172,8 +184,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/console-log-each.svg
 [npm-url]: https://npmjs.org/package/@stdlib/console-log-each
 
-[test-image]: https://github.com/stdlib-js/console-log-each/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/console-log-each/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/console-log-each/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/console-log-each/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/console-log-each/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/console-log-each?branch=main
@@ -186,7 +198,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -202,6 +214,10 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/console-log-each/main/LICENSE
 
+[@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/stdlib
+
+[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/stdlib
+
 </section>
 
 <!-- /.links -->

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import logEach from '../docs/types/index';
+export = logEach;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var q=function(u,s){return function(){return s||u((s={exports:{}}).exports,s),s.exports}};var d=q(function(P,m){
+var w=require('@stdlib/assert-is-string/dist').isPrimitive,c=require('@stdlib/assert-is-collection/dist'),p=require('@stdlib/array-base-accessors/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),E=require('@stdlib/console-log/dist');function b(u){var s,l,t,h,o,n,v,r,g,i,e,a;if(!w(u))throw new TypeError(f('1aZ3F',u));for(o=arguments.length,t=[],s=[],n=[],e=1;e<o;e++)if(r=arguments[e],c(r)){i=p(r),t.push(i.accessors[0]),n.push(r),s.push(1),v=r.length,e+=1;break}else r=[r],i=p(r),t.push(i.accessors[0]),n.push(r),s.push(0);for(v===void 0&&(v=1);e<o;e++){if(r=arguments[e],c(r)){if(r.length!==v)throw new RangeError(format('1aZD1'));g=1}else r=[r],g=0;i=p(r),t.push(i.accessors[0]),n.push(r),s.push(g)}for(h=[u],l=[],e=1;e<o;e++)h.push(null),l.push(0);for(e=0;e<v;e++){for(a=0;a<o-1;a++)h[a+1]=t[a](n[a],l[a]),l[a]+=s[a];E(f.apply(null,h))}}m.exports=b
+});var x=d();module.exports=x;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar accessors = require( '@stdlib/array-base-accessors' );\nvar format = require( '@stdlib/string-format' );\nvar logger = require( '@stdlib/console-log' );\n\n\n// MAIN //\n\n/**\n* Inserts array element values into a format string and prints the result.\n*\n* @param {string} str - format string\n* @param {...(Collection|*)} args - collections or values\n* @throws {TypeError} first argument must be a string\n* @throws {RangeError} provided collections must have the same length\n* @returns {void}\n*/\nfunction logEach( str ) {\n\tvar strides;\n\tvar offsets;\n\tvar getters;\n\tvar values;\n\tvar nargs;\n\tvar args;\n\tvar len;\n\tvar v;\n\tvar s;\n\tvar o;\n\tvar i;\n\tvar j;\n\tif ( !isString( str ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );\n\t}\n\tnargs = arguments.length;\n\tgetters = [];\n\tstrides = [];\n\targs = [];\n\tfor ( i = 1; i < nargs; i++ ) {\n\t\tv = arguments[ i ];\n\t\tif ( isCollection( v ) ) {\n\t\t\to = accessors( v );\n\t\t\tgetters.push( o.accessors[ 0 ] );\n\t\t\targs.push( v );\n\t\t\tstrides.push( 1 );\n\t\t\tlen = v.length;\n\t\t\ti += 1;\n\t\t\tbreak;\n\t\t} else {\n\t\t\tv = [ v ];\n\t\t\to = accessors( v );\n\t\t\tgetters.push( o.accessors[ 0 ] );\n\t\t\targs.push( v );\n\t\t\tstrides.push( 0 );\n\t\t}\n\t}\n\tif ( len === void 0 ) {\n\t\tlen = 1;\n\t}\n\tfor ( ; i < nargs; i++ ) {\n\t\tv = arguments[ i ];\n\t\tif ( isCollection( v ) ) {\n\t\t\tif ( v.length !== len ) {\n\t\t\t\tthrow new RangeError( 'invalid argument. Provided collections must have the same length.' );\n\t\t\t}\n\t\t\ts = 1;\n\t\t} else {\n\t\t\tv = [ v ];\n\t\t\ts = 0;\n\t\t}\n\t\to = accessors( v );\n\t\tgetters.push( o.accessors[ 0 ] );\n\t\targs.push( v );\n\t\tstrides.push( s );\n\t}\n\tvalues = [ str ];\n\toffsets = [];\n\tfor ( i = 1; i < nargs; i++ ) {\n\t\tvalues.push( null );\n\t\toffsets.push( 0 );\n\t}\n\tfor ( i = 0; i < len; i++ ) {\n\t\tfor ( j = 0; j < nargs-1; j++ ) {\n\t\t\tvalues[ j+1 ] = getters[ j ]( args[ j ], offsets[ j ] );\n\t\t\toffsets[ j ] += strides[ j ];\n\t\t}\n\t\tlogger( format.apply( null, values ) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = logEach;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Insert array element values into a format string and print the result.\n*\n* @module @stdlib/console-log-each\n*\n* @example\n* var logEach = require( '@stdlib/console-log-each' );\n*\n* var x = [ 1, 2, 3 ];\n* var y = [ 4, 5, 6 ];\n*\n* logEach( '%d < %d ', x, y );\n* // e.g., => '1 < 4\\n2 < 5\\n3 < 6\\n'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAe,QAAS,8BAA+B,EACvDC,EAAY,QAAS,8BAA+B,EACpDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAS,QAAS,qBAAsB,EAc5C,SAASC,EAASC,EAAM,CACvB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,CAAClB,EAAUM,CAAI,EACnB,MAAM,IAAI,UAAWH,EAAQ,kEAAmEG,CAAI,CAAE,EAMvG,IAJAK,EAAQ,UAAU,OAClBF,EAAU,CAAC,EACXF,EAAU,CAAC,EACXK,EAAO,CAAC,EACFK,EAAI,EAAGA,EAAIN,EAAOM,IAEvB,GADAH,EAAI,UAAWG,CAAE,EACZhB,EAAca,CAAE,EAAI,CACxBE,EAAId,EAAWY,CAAE,EACjBL,EAAQ,KAAMO,EAAE,UAAW,CAAE,CAAE,EAC/BJ,EAAK,KAAME,CAAE,EACbP,EAAQ,KAAM,CAAE,EAChBM,EAAMC,EAAE,OACRG,GAAK,EACL,KACD,MACCH,EAAI,CAAEA,CAAE,EACRE,EAAId,EAAWY,CAAE,EACjBL,EAAQ,KAAMO,EAAE,UAAW,CAAE,CAAE,EAC/BJ,EAAK,KAAME,CAAE,EACbP,EAAQ,KAAM,CAAE,EAMlB,IAHKM,IAAQ,SACZA,EAAM,GAECI,EAAIN,EAAOM,IAAM,CAExB,GADAH,EAAI,UAAWG,CAAE,EACZhB,EAAca,CAAE,EAAI,CACxB,GAAKA,EAAE,SAAWD,EACjB,MAAM,IAAI,WAAY,mEAAoE,EAE3FE,EAAI,CACL,MACCD,EAAI,CAAEA,CAAE,EACRC,EAAI,EAELC,EAAId,EAAWY,CAAE,EACjBL,EAAQ,KAAMO,EAAE,UAAW,CAAE,CAAE,EAC/BJ,EAAK,KAAME,CAAE,EACbP,EAAQ,KAAMQ,CAAE,CACjB,CAGA,IAFAL,EAAS,CAAEJ,CAAI,EACfE,EAAU,CAAC,EACLS,EAAI,EAAGA,EAAIN,EAAOM,IACvBP,EAAO,KAAM,IAAK,EAClBF,EAAQ,KAAM,CAAE,EAEjB,IAAMS,EAAI,EAAGA,EAAIJ,EAAKI,IAAM,CAC3B,IAAMC,EAAI,EAAGA,EAAIP,EAAM,EAAGO,IACzBR,EAAQQ,EAAE,CAAE,EAAIT,EAASS,CAAE,EAAGN,EAAMM,CAAE,EAAGV,EAASU,CAAE,CAAE,EACtDV,EAASU,CAAE,GAAKX,EAASW,CAAE,EAE5Bd,EAAQD,EAAO,MAAO,KAAMO,CAAO,CAAE,CACtC,CACD,CAKAX,EAAO,QAAUM,IC9EjB,IAAIc,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isString", "isCollection", "accessors", "format", "logger", "logEach", "str", "strides", "offsets", "getters", "values", "nargs", "args", "len", "v", "s", "o", "i", "j", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Inserts array element values into a format string and prints the result.
@@ -27,7 +27,7 @@
 *
 * @param str - format string
 * @param args - collections or values
-* @throws {RangeError} provided collections must have the same length
+* @throws provided collections must have the same length
 *
 * @example
 * var logEach = require( `@stdlib/console/log-each` );

package/lib/main.js

@@ -22,6 +22,7 @@
 
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 var isCollection = require( '@stdlib/assert-is-collection' );
+var accessors = require( '@stdlib/array-base-accessors' );
 var format = require( '@stdlib/string-format' );
 var logger = require( '@stdlib/console-log' );
 
@@ -40,30 +41,38 @@ var logger = require( '@stdlib/console-log' );
 function logEach( str ) {
 	var strides;
 	var offsets;
+	var getters;
 	var values;
 	var nargs;
 	var args;
 	var len;
 	var v;
 	var s;
+	var o;
 	var i;
 	var j;
 	if ( !isString( str ) ) {
 		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
 	nargs = arguments.length;
+	getters = [];
 	strides = [];
 	args = [];
 	for ( i = 1; i < nargs; i++ ) {
 		v = arguments[ i ];
 		if ( isCollection( v ) ) {
+			o = accessors( v );
+			getters.push( o.accessors[ 0 ] );
 			args.push( v );
 			strides.push( 1 );
 			len = v.length;
 			i += 1;
 			break;
 		} else {
-			args.push( [ v ] );
+			v = [ v ];
+			o = accessors( v );
+			getters.push( o.accessors[ 0 ] );
+			args.push( v );
 			strides.push( 0 );
 		}
 	}
@@ -81,6 +90,8 @@ function logEach( str ) {
 			v = [ v ];
 			s = 0;
 		}
+		o = accessors( v );
+		getters.push( o.accessors[ 0 ] );
 		args.push( v );
 		strides.push( s );
 	}
@@ -92,7 +103,7 @@ function logEach( str ) {
 	}
 	for ( i = 0; i < len; i++ ) {
 		for ( j = 0; j < nargs-1; j++ ) {
-			values[ j+1 ] = args[ j ][ offsets[ j ] ];
+			values[ j+1 ] = getters[ j ]( args[ j ], offsets[ j ] );
 			offsets[ j ] += strides[ j ];
 		}
 		logger( format.apply( null, values ) );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/console-log-each",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Insert array element values into a format string and print the result.",
   "license": "Apache-2.0",
   "author": {
@@ -37,20 +37,23 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/console-log": "^0.0.x",
-    "@stdlib/string-format": "^0.0.x"
+    "@stdlib/array-base-accessors": "^0.1.0",
+    "@stdlib/assert-is-collection": "^0.1.0",
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/console-log": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-filled-by": "^0.0.x",
-    "@stdlib/array-zeros": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/random-base-discrete-uniform": "^0.0.x",
-    "@stdlib/utils-map": "^0.0.x",
-    "@stdlib/utils-nary-function": "^0.0.x",
+    "@stdlib/array-complex128": "^0.1.0",
+    "@stdlib/array-filled-by": "^0.0.2",
+    "@stdlib/array-zeros": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/random-base-discrete-uniform": "^0.0.6",
+    "@stdlib/utils-map": "^0.0.1",
+    "@stdlib/utils-nary-function": "^0.1.0",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
@@ -75,7 +78,7 @@
     "stdlib"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,24 +0,0 @@
-
-{{alias}}( str[, ...args] )
-    Inserts array element values into a format string and prints the result.
-
-    If an interpolated argument is not a collection, the argument is broadcasted
-    for each iteration.
-
-    Parameters
-    ----------
-    str: String
-        Format string.
-
-    args: ...any (optional)
-        Collections or values.
-
-    Examples
-    --------
-    > var x = [ 1, 2, 3 ];
-    > var y = [ 4, 5, 6 ];
-    > {{alias}}( '%d < %d ', x, y );
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,39 +0,0 @@
-/*
-* @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 logEach = require( './index' );
-
-
-// TESTS //
-
-// The function returns undefined...
-{
-	logEach( '%d', [ 1, 2, 3 ] ); // $ExpectType void
-	logEach( '%d, %d', [ 1, 2, 3 ], 2 ); // $ExpectType void
-	logEach( '%d, %d', [ 1, 2, 3 ], [ 2, 3, 4 ] ); // $ExpectType void
-}
-
-// The compiler throws an error if the function is provided a first argument which is not string...
-{
-	logEach( 123, [ 1, 2, 3 ] );  // $ExpectError
-	logEach( true, [ 1, 2, 3 ] ); // $ExpectError
-	logEach( false, [ 1, 2, 3 ] ); // $ExpectError
-	logEach( {}, [ 1, 2, 3 ] ); // $ExpectError
-	logEach( null, [ 1, 2, 3 ] ); // $ExpectError
-	logEach( undefined, [ 1, 2, 3 ] ); // $ExpectError
-}