@stdlib/utils-async-map-function

Invoke a function n times and return an array of accumulated function return values.

https://github.com/stdlib-js/utils-async-map-function

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary

Keywords

async asynchronous fcn fun func function javascript map node node-js nodejs ntimes repeat replicate stdlib times util utilities utility utils

Keywords from Contributors

iterator partial bifurcate abbreviate assert prop property symbol mask normal

Last synced: 4 months ago · JSON representation ·

Repository

Invoke a function n times and return an array of accumulated function return values.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 968 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

async asynchronous fcn fun func function javascript map node node-js nodejs ntimes repeat replicate stdlib times util utilities utility utils

Created over 4 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

mapFunAsync

Invoke a function n times and return an array of accumulated function return values.

## Installation ```bash npm install @stdlib/utils-async-map-function ``` 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 mapFunAsync = require( '@stdlib/utils-async-map-function' ); ``` #### mapFunAsync( fcn, n, \[options,] done ) Invokes a function `n` times and returns an `array` of accumulated function return values. ```javascript function fcn( i, next ) { var t = 300 - (i*50); setTimeout( onTimeout, t ); function onTimeout() { console.log( i ); next( null, i ); } } function done( error, arr ) { if ( error ) { throw error; } console.log( arr ); } mapFunAsync( fcn, 5, done ); /* => 4 3 2 1 0 [ 0, 1, 2, 3, 4 ] */ ``` For each iteration, the provided function is invoked with two arguments: - `index`: invocation index (starting from zero). - `next`: callback to be invoked upon function completion. The `next` callback accepts two arguments: - `error`: error argument. - `result`: function result. The function accepts the following `options`: - `limit`: the maximum number of pending invocations at any one time. Default: `infinity`. - `series`: `boolean` indicating whether to sequentially invoke `fcn`. If `true`, the function sets `options.limit=1`. Default: `false`. - `thisArg`: the execution context for `fcn`. By default, all invocations are performed concurrently, which means that the function does **not** guarantee completion order. To invoke a function such that only one invocation is pending at any one time, set the `series` option to `true`. ```javascript function fcn( i, next ) { var t = 300 - (i*50); setTimeout( onTimeout, t ); function onTimeout() { console.log( i ); next( null, i ); } } function done( error, arr ) { if ( error ) { throw error; } console.log( arr ); } var opts = { 'series': true }; mapFunAsync( fcn, 5, opts, done ); /* => 0 1 2 3 4 [ 0, 1, 2, 3, 4 ] */ ``` To limit the maximum number of pending function invocations, set the `limit` option. ```javascript var delays = [ 300, 250, 225, 150, 100 ]; function fcn( i, next ) { setTimeout( onTimeout, delays[ i ] ); function onTimeout() { console.log( i ); next( null, i ); } } function done( error, arr ) { if ( error ) { throw error; } console.log( arr ); } var opts = { 'limit': 2 }; mapFunAsync( fcn, 5, opts, done ); /* => 1 0 3 2 4 [ 0, 1, 2, 3, 4 ] */ ``` To set the execution context of `fcn`, set the `thisArg` option. ```javascript function fcn( i, next ) { this.count += 1; setTimeout( onTimeout, 0 ); function onTimeout() { next( null, i ); } } function done( error, arr ) { if ( error ) { throw error; } console.log( arr ); // => [ 0, 1, 2, 3, 4 ] } var ctx = { 'count': 0 }; var opts = { 'thisArg': ctx }; mapFunAsync( fcn, 5, opts, done ); ``` #### mapFunAsync.factory( \[options,] fcn ) Returns a `function` which invokes a function `n` times and returns an `array` of accumulated function return values. ```javascript function fcn( i, next ) { var t = 300 - (i*50); setTimeout( onTimeout, t ); function onTimeout() { console.log( i ); next( null, i ); } } function done( error, arr ) { if ( error ) { throw error; } console.log( arr ); } var opts = { 'series': true }; var f = mapFunAsync.factory( opts, fcn ); f( 5, done ); /* => 0 1 2 3 4 [ 0, 1, 2, 3, 4 ] */ f( 2, done ); /* => 0 1 [ 0, 1 ] */ ``` The function accepts the same `options` as `mapFunAsync()`.

## Notes - If a provided function calls the `next` callback with a truthy `error` argument, the function suspends execution and immediately calls the `done` callback for subsequent `error` handling. - **Neither** `mapFunAsync` nor the function returned by the `factory` method **guarantee** asynchronous execution. To guarantee asynchrony, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).

## Examples ```javascript var randu = require( '@stdlib/random-base-randu' ); var mapFunAsync = require( '@stdlib/utils-async-map-function' ); function rand( i, next ) { var t = randu() * i; setTimeout( onTimeout, t ); function onTimeout() { next( null, t ); } } function done( error, out ) { if ( error ) { throw error; } console.log( out ); } mapFunAsync( rand, 10, done ); ```

* * * ## 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].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

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

GitHub Events

Total

Push event: 23

Last Year

Push event: 23

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 52
Total Committers: 2
Avg Commits per committer: 26.0
Development Distribution Score (DDS): 0.019

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	51
Philipp Burckhardt	p**t@o**m	1

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 15 last-month

Total dependent packages: 3
Total dependent repositories: 1
Total versions: 12
Total maintainers: 4

npmjs.org: @stdlib/utils-async-map-function

Invoke a function n times and return an array of accumulated function return values.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 12
Dependent Packages: 3
Dependent Repositories: 1
Downloads: 15 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 10.3%

Average: 13.5%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 19.3%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

package.json npm

@stdlib/assert-is-array ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
@stdlib/utils-noop ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-boolean ^0.0.x
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-nonnegative-integer ^0.0.x
@stdlib/assert-is-plain-object ^0.0.x
@stdlib/assert-is-positive-integer ^0.0.x
@stdlib/constants-float64-pinf ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
debug ^2.6.9

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/utils-async-map-function

Science Score: 44.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

mapFunAsync

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/utils-async-map-function

Rankings

Maintainers (4)

Funding

Dependencies