@duzun/async-series

asyncSeries.js

Asynchronously process a list of items consecutively.

Even though the processing is asynchronous, it is never done in parallel.

Install

npm i -S @duzun/async-series

Import or require

This library can be included either as an ESM or UMD.

ESM

import {
    forEach as eachSeries,
    map     as mapSeries,
    reduce  as reduceSeries
} from '@duzun/async-series';

CommonJS

const {
    forEach: eachSeries,
    map    : mapSeries,
    reduce : reduceSeries,
} = require('@duzun/async-series');

AMD

require('https://unpkg.com/@duzun/async-series', (asyncSeries) => {
    const {
        forEach: eachSeries,
        map    : mapSeries,
        reduce : reduceSeries,
    } = asyncSeries;

    // ...
});

Browser

<script src="https://unpkg.com/@duzun/async-series"></script>
<script>
const {
    forEach: eachSeries,
    map    : mapSeries,
    reduce : reduceSeries,
} = asyncSeries;
</script>

Usage by example

forEach(array, iteratee)

Where [async ]iteratee(value, index, array)

Process file contents of a directory, asynchronously & consecutively.

const fs = require('mz/fs');
const { forEach: eachSeries } = require('@duzun/async-series');

(async () => {
    let files = await fs.readdir('.');
    let results = await eachSeries(files, async (filename, idx) => {
        if((await fs.stat(filename)).isDirectory()) return;
        let contents = await fs.readFile(filename);

        // Do some heavy processing here...
    });
})();

map(array, iteratee[, firstValue])

Where [async ]iteratee(value, index, array)

Get file contents of a directory, asynchronously & consecutively;

const fs = require('mz/fs');
const { map: mapSeries } = require('@duzun/async-series');

(async () => {
    let files = await fs.readdir('.');
    let contents = await mapSeries(files, async (filename, idx) => {
        if((await fs.stat(filename)).isDirectory()) return;
        return fs.readFile(filename, 'utf8');
    });
    contents = contents.filter((x) => x);
})();

reduce(array, reducer[, initialValue])

Where [async ]reducer(accumulator, currentValue, index, array)

Calculate file sizes in a directory, asynchronously & consecutively.

const fs = require('mz/fs');
const { reduce: reduceSeries } = require('@duzun/async-series');

(async () => {
    let files = await fs.readdir('.');
    let size = await reduceSeries(files, async (size, filename, idx) => {
        let stats = await fs.stat(filename);
        if(stats.isDirectory()) return size;
        return size + stats.size;
    }, 0);

    console.log('size: ', size);
})();

Why?

Why not? :)

I know, there is a great library Async.js, which already has eachSeries, mapSeries and reduce and many other functions.

This library is < 900 bytes minified, and < 500 bytes when also gzipped.

And if you include it with rollup.js, you only get the function you've imported.