index.js

/**
 * Async 上下文中的 "异步函数" 是一个异步函数,具有可变数量的参数,最后一个参数是回调。(`function (arg1, arg2, ..., callback) {}`)最后一个回调的形式为 `callback(err, results...)`,必须在函数完成后调用。回调应以 Error 作为其第一个参数来调用,以表示发生了错误。否则,如果没有发生错误,则应以 `null` 作为第一个参数以及可能适用的任何其他 `result` 参数来调用它,以表示成功完成。回调必须只调用一次,最好是在 JavaScript 事件循环的后续滴答声中。
 * 这种类型的函数也称为 "Node 样式异步函数" 或 "延续传递样式函数" (CPS)。此库的大多数方法本身就是 CPS/Node 样式的异步函数,或者返回 CPS/Node 样式的异步函数的函数。
 * 只要我们接受 Node 样式的异步函数,我们也直接接受 [ES2017 `async` 函数]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function}。这种情况下,`async` 函数将不会被传递最终的回调参数,任何抛出的错误都将作为隐式回调的 `err` 参数,返回值将作为 `result` 值。(即返回的 Promise 的 `rejected` 成为 `err` 回调参数,`resolved` 值成为 `result`。)
 * 请注意,由于 JavaScript 的限制,我们只能检测原生 `async` 函数,而不能检测转译的实现。你的环境必须支持 `async`/`await` 才能正常工作。(例如 Node > v7.6,或现代浏览器的最新版本)。如果你通过转译器(例如 Babel)使用 `async` 函数,你仍然必须使用 [asyncify]{@link module:Utils.asyncify} 封装该函数,因为 `async function` 将被编译为返回 promise 的普通函数。
 *
* @typedef {Function} AsyncFunction
 * @static
 */

/**
 * Async 是一个实用模块,它提供了用于异步 JavaScript 的直接、强大的函数。虽然最初设计用于 [Node.js](http://nodejs.org) 并可通过 `npm install --save async` 安装,但它也可以直接在浏览器中使用。
 *
* @module async
 * @see AsyncFunction
 */


/**
 * 一组 `async` 函数,用于操作集合,例如数组和对象。
 *
* @module Collections
 */

/**
 * 一组 `async` 函数,用于控制脚本的流程。
 *
* @module ControlFlow
 */

/**
 * 一组 `async` 实用函数。
 *
* @module Utils
 */

import apply from './apply'
import applyEach from './applyEach'
import applyEachSeries from './applyEachSeries'
import asyncify from './asyncify'
import auto from './auto'
import autoInject from './autoInject'
import cargo from './cargo'
import cargoQueue from './cargoQueue'
import compose from './compose'
import concat from './concat'
import concatLimit from './concatLimit'
import concatSeries from './concatSeries'
import constant from './constant'
import detect from './detect'
import detectLimit from './detectLimit'
import detectSeries from './detectSeries'
import dir from './dir'
import doUntil from './doUntil'
import doWhilst from './doWhilst'
import each from './each'
import eachLimit from './eachLimit'
import eachOf from './eachOf'
import eachOfLimit from './eachOfLimit'
import eachOfSeries from './eachOfSeries'
import eachSeries from './eachSeries'
import ensureAsync from './ensureAsync'
import every from './every'
import everyLimit from './everyLimit'
import everySeries from './everySeries'
import filter from './filter'
import filterLimit from './filterLimit'
import filterSeries from './filterSeries'
import forever from './forever'
import groupBy from './groupBy'
import groupByLimit from './groupByLimit'
import groupBySeries from './groupBySeries'
import log from './log'
import map from './map'
import mapLimit from './mapLimit'
import mapSeries from './mapSeries'
import mapValues from './mapValues'
import mapValuesLimit from './mapValuesLimit'
import mapValuesSeries from './mapValuesSeries'
import memoize from './memoize'
import nextTick from './nextTick'
import parallel from './parallel'
import parallelLimit from './parallelLimit'
import priorityQueue from './priorityQueue'
import queue from './queue'
import race from './race'
import reduce from './reduce'
import reduceRight from './reduceRight'
import reflect from './reflect'
import reflectAll from './reflectAll'
import reject from './reject'
import rejectLimit from './rejectLimit'
import rejectSeries from './rejectSeries'
import retry from './retry'
import retryable from './retryable'
import seq from './seq'
import series from './series'
import setImmediate from './setImmediate'
import some from './some'
import someLimit from './someLimit'
import someSeries from './someSeries'
import sortBy from './sortBy'
import timeout from './timeout'
import times from './times'
import timesLimit from './timesLimit'
import timesSeries from './timesSeries'
import transform from './transform'
import tryEach from './tryEach'
import unmemoize from './unmemoize'
import until from './until'
import waterfall from './waterfall'
import whilst from './whilst'

export default {
    apply,
    applyEach,
    applyEachSeries,
    asyncify,
    auto,
    autoInject,
    cargo,
    cargoQueue,
    compose,
    concat,
    concatLimit,
    concatSeries,
    constant,
    detect,
    detectLimit,
    detectSeries,
    dir,
    doUntil,
    doWhilst,
    each,
    eachLimit,
    eachOf,
    eachOfLimit,
    eachOfSeries,
    eachSeries,
    ensureAsync,
    every,
    everyLimit,
    everySeries,
    filter,
    filterLimit,
    filterSeries,
    forever,
    groupBy,
    groupByLimit,
    groupBySeries,
    log,
    map,
    mapLimit,
    mapSeries,
    mapValues,
    mapValuesLimit,
    mapValuesSeries,
    memoize,
    nextTick,
    parallel,
    parallelLimit,
    priorityQueue,
    queue,
    race,
    reduce,
    reduceRight,
    reflect,
    reflectAll,
    reject,
    rejectLimit,
    rejectSeries,
    retry,
    retryable,
    seq,
    series,
    setImmediate,
    some,
    someLimit,
    someSeries,
    sortBy,
    timeout,
    times,
    timesLimit,
    timesSeries,
    transform,
    tryEach,
    unmemoize,
    until,
    waterfall,
    whilst,

    // aliases
    all: every,
    allLimit: everyLimit,
    allSeries: everySeries,
    any: some,
    anyLimit: someLimit,
    anySeries: someSeries,
    find: detect,
    findLimit: detectLimit,
    findSeries: detectSeries,
    flatMap: concat,
    flatMapLimit: concatLimit,
    flatMapSeries: concatSeries,
    forEach: each,
    forEachSeries: eachSeries,
    forEachLimit: eachLimit,
    forEachOf: eachOf,
    forEachOfSeries: eachOfSeries,
    forEachOfLimit: eachOfLimit,
    inject: reduce,
    foldl: reduce,
    foldr: reduceRight,
    select: filter,
    selectLimit: filterLimit,
    selectSeries: filterSeries,
    wrapSync: asyncify,
    during: whilst,
    doDuring: doWhilst
};

export {
    apply as apply,
    applyEach as applyEach,
    applyEachSeries as applyEachSeries,
    asyncify as asyncify,
    auto as auto,
    autoInject as autoInject,
    cargo as cargo,
    cargoQueue as cargoQueue,
    compose as compose,
    concat as concat,
    concatLimit as concatLimit,
    concatSeries as concatSeries,
    constant as constant,
    detect as detect,
    detectLimit as detectLimit,
    detectSeries as detectSeries,
    dir as dir,
    doUntil as doUntil,
    doWhilst as doWhilst,
    each as each,
    eachLimit as eachLimit,
    eachOf as eachOf,
    eachOfLimit as eachOfLimit,
    eachOfSeries as eachOfSeries,
    eachSeries as eachSeries,
    ensureAsync as ensureAsync,
    every as every,
    everyLimit as everyLimit,
    everySeries as everySeries,
    filter as filter,
    filterLimit as filterLimit,
    filterSeries as filterSeries,
    forever as forever,
    groupBy as groupBy,
    groupByLimit as groupByLimit,
    groupBySeries as groupBySeries,
    log as log,
    map as map,
    mapLimit as mapLimit,
    mapSeries as mapSeries,
    mapValues as mapValues,
    mapValuesLimit as mapValuesLimit,
    mapValuesSeries as mapValuesSeries,
    memoize as memoize,
    nextTick as nextTick,
    parallel as parallel,
    parallelLimit as parallelLimit,
    priorityQueue as priorityQueue,
    queue as queue,
    race as race,
    reduce as reduce,
    reduceRight as reduceRight,
    reflect as reflect,
    reflectAll as reflectAll,
    reject as reject,
    rejectLimit as rejectLimit,
    rejectSeries as rejectSeries,
    retry as retry,
    retryable as retryable,
    seq as seq,
    series as series,
    setImmediate as setImmediate,
    some as some,
    someLimit as someLimit,
    someSeries as someSeries,
    sortBy as sortBy,
    timeout as timeout,
    times as times,
    timesLimit as timesLimit,
    timesSeries as timesSeries,
    transform as transform,
    tryEach as tryEach,
    unmemoize as unmemoize,
    until as until,
    waterfall as waterfall,
    whilst as whilst,

    // Aliases
    every as all,
    everyLimit as allLimit,
    everySeries as allSeries,
    some as any,
    someLimit as anyLimit,
    someSeries as anySeries,
    detect as find,
    detectLimit as findLimit,
    detectSeries as findSeries,
    concat as flatMap,
    concatLimit as flatMapLimit,
    concatSeries as flatMapSeries,
    each as forEach,
    eachSeries as forEachSeries,
    eachLimit as forEachLimit,
    eachOf as forEachOf,
    eachOfSeries as forEachOfSeries,
    eachOfLimit as forEachOfLimit,
    reduce as inject,
    reduce as foldl,
    reduceRight as foldr,
    filter as select,
    filterLimit as selectLimit,
    filterSeries as selectSeries,
    asyncify as wrapSync,
    whilst as during,
    doWhilst as doDuring
};