npm package: @stdlib/console-log-each-map
Description: Insert array element values and the result of a callback function into a format string and print the result.
Author: The Stdlib Authors
Latest version: 0.1.1

<!--

@license Apache-2.0

Copyright (c) 2025 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.

-->


<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>

# logEachMap

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Insert array element values and the result of a callback function into a [format string][@stdlib/string/format] and print the result.

<!-- 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/console-log-each-map
```

</section>

<section class="usage">

## 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`.

<!-- eslint-disable no-invalid-this -->

```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.

</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 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>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```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 );
```

</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-2026. 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/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=v0.1.1
[test-url]: https://github.com/stdlib-js/console-log-each-map/actions/workflows/test.yml?query=branch:v0.1.1

[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

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/console-log-each-map.svg
[dependencies-url]: https://david-dm.org/stdlib-js/console-log-each-map/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[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://www.npmjs.com/package/@stdlib/array-complex128

[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64

[@stdlib/string/format]: https://www.npmjs.com/package/@stdlib/string-format

</section>

<!-- /.links -->