https://github.com/stdlib-js/console-log-each-map
Insert array element values and the result of a callback function into a format string and print the result.
https://github.com/stdlib-js/console-log-each-map
array console debug debugging each element foreach format javascript log logger map node node-js nodejs print stdlib string
Last synced: 7 months ago
JSON representation
Insert array element values and the result of a callback function into a format string and print the result.
- Host: GitHub
- URL: https://github.com/stdlib-js/console-log-each-map
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-03-17T06:04:58.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-22T23:09:23.000Z (10 months ago)
- Last Synced: 2025-04-13T05:46:12.764Z (9 months ago)
- Topics: array, console, debug, debugging, each, element, foreach, format, javascript, log, logger, map, node, node-js, nodejs, print, stdlib, string
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 596 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# logEachMap
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Insert array element values and the result of a callback function into a [format string][@stdlib/string/format] and print the result.
## Installation
```bash
npm install @stdlib/console-log-each-map
```
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 logEachMap = require( '@stdlib/console-log-each-map' );
```
#### logEachMap( str\[, ...args], clbk\[, thisArg] )
Inserts array element values and the result of a callback function into a [format string][@stdlib/string/format] and prints the result.
```javascript
function add( a, b ) {
return a + b;
}
var x = [ 1, 2, 3 ];
var y = [ 4, 5, 6 ];
logEachMap( '%d + %d = %d', x, y, add );
// e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'
```
The function accepts the following arguments:
- **str**: format string.
- **args**: input arrays _(optional)_.
- **clbk**: callback function.
- **thisArg**: callback execution context _(optional)_.
To set the callback execution context, provide a `thisArg`.
```javascript
function count( x, y ) {
this.count += 1;
return x + y;
}
var x = [ 1, 2, 3 ];
var y = [ 4, 5, 6 ];
var ctx = {
'count': 0
};
logEachMap( '%d + %d = %d', x, y, count, ctx );
// e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'
var v = ctx.count;
// returns 3
```
If an interpolated argument is not an array-like object, the argument is broadcasted for each iteration.
```javascript
function multiply( x, y ) {
return x * y;
}
var x = [ 1, 2, 3 ];
var y = 0.5;
logEachMap( '%0.1f * %0.1f = %0.1f', x, y, multiply );
// e.g., => '1.0 * 0.5 = 0.5\n2.0 * 0.5 = 1.0\n3.0 * 0.5 = 1.5\n'
```
The callback function is provided the following arguments:
- **arg0**: current array element for the first broadcasted array.
- **arg1**: current array element for the second broadcasted array.
- **...argN**: current array element for the nth broadcasted array.
- **index**: current element index.
- **arrays**: broadcasted arrays. If an argument was broadcasted, the corresponding array is a single-element generic array containing the original element.
The number of `argX` arguments is determined according to the number of provided `args` arguments. If no `args` are provided, the callback is invoked without any arguments.
## Notes
- 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).
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
function add( x, y ) {
return x + y;
}
var x = discreteUniform( 10, -50, 50, {
'dtype': 'float64'
});
var y = discreteUniform( 10, -50, 50, {
'dtype': 'float64'
});
logEachMap( '%d + %d = %d', x, y, add );
```
* * *
## 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].
[npm-image]: http://img.shields.io/npm/v/@stdlib/console-log-each-map.svg
[npm-url]: https://npmjs.org/package/@stdlib/console-log-each-map
[test-image]: https://github.com/stdlib-js/console-log-each-map/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/console-log-each-map/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/console-log-each-map/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/console-log-each-map?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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/console-log-each-map/tree/deno
[deno-readme]: https://github.com/stdlib-js/console-log-each-map/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/console-log-each-map/tree/umd
[umd-readme]: https://github.com/stdlib-js/console-log-each-map/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/console-log-each-map/tree/esm
[esm-readme]: https://github.com/stdlib-js/console-log-each-map/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/console-log-each-map/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/console-log-each-map/main/LICENSE
[@stdlib/array/complex128]: https://github.com/stdlib-js/array-complex128
[@stdlib/array/complex64]: https://github.com/stdlib-js/array-complex64
[@stdlib/string/format]: https://github.com/stdlib-js/string-format