Async



async

async

Async عبارة عن وحدة مساعدة تقدم وظائف قوية ومباشرة للعمل مع جافا سكريبت غير المتزامن. على الرغم من أنها مصممة أصلاً للاستخدام مع Node.js وقابلة للتثبيت عبر npm install --save async ، يمكن أيضًا استخدامه مباشرة في المستعرض.

مصدر:
index.js ، السطر 40
نرى:
AsyncFunction

مجموعات

مجموعة من وظائف async للتلاعب بالمجموعات ، مثل المصفوفات والأشياء.

مصدر:
index.js ، السطر 50

أساليب

(ثابت) concat (coll، iteratee، callback (err) opt )

import concat from 'async/concat';

يطبق iteratee على كل عنصر في coll ، متصلاً النتائج. إرجاع القائمة المتسلسلة. يتم استدعاء iteratee s بالتوازي ، ويتم متصلاً النتائج أثناء إرجاعها. ليس هناك ما يضمن أن صفيف النتائج سيتم إرجاعه في الترتيب الأصلي iteratee تم تمريرها إلى الدالة iteratee .

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

دالة لتطبيقها على كل عنصر في المجموعة ، والتي يجب أن تستخدم مصفوفة كنتيجة لها. استدعى مع (البند ، رد الاتصال).

callback(err) وظيفة <اختياري>

تم إجراء رد اتصال يسمى بعد إنهاء كافة دالات iteratee أو حدوث خطأ. النتائج هي مصفوفة تحتوي على النتائج المتسلسلة الخاصة بوظيفة iteratee . استدعى مع (يخطئ ، النتائج).

مثال

async.concat(['dir1','dir2','dir3'], fs.readdir, function(err, files) {
    // files is now a list of filenames that exist in the 3 directories
});
مصدر:
concat.js ، السطر 4

(ثابت) concatLimit (coll، limit، iteratee، callback opt )

import concatLimit from 'async/concatLimit';

نفس concat ولكن تشغيل عمليات async limit في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

دالة لتطبيقها على كل عنصر في المجموعة ، والتي يجب أن تستخدم مصفوفة كنتيجة لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم إجراء رد اتصال يسمى بعد إنهاء كافة دالات iteratee أو حدوث خطأ. النتائج هي مصفوفة تحتوي على النتائج المتسلسلة الخاصة بوظيفة iteratee . استدعى مع (يخطئ ، النتائج).

مصدر:
concatLimit.js ، السطر 8
نرى:

concat

(static) concatSeries (coll، iteratee، callback (err) opt )

import concatSeries from 'async/concatSeries';

نفس concat ولكن تشغيل عملية متزامن واحد فقط في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة لتطبيقها على كل عنصر في المجموعة. يجب أن يكمل iteratee مصفوفة مجموعة من النتائج. استدعى مع (البند ، رد الاتصال).

callback(err) وظيفة <اختياري>

تم إجراء رد اتصال يسمى بعد إنهاء كافة دالات iteratee أو حدوث خطأ. النتائج هي مصفوفة تحتوي على النتائج المتسلسلة الخاصة بوظيفة iteratee . استدعى مع (يخطئ ، النتائج).

مصدر:
concatSeries.js ، السطر 4
نرى:

concat

(ثابت) كشف (coll، iteratee، callback opt )

import detect from 'async/detect';

تُرجع القيمة الأولى في coll التي تمر باختبار للحقيقة غير متزامن. يتم تطبيق iteratee بالتوازي ، بمعنى أن iteratee الأول لإرجاع true سيؤدي إلى callback مع هذه النتيجة. وهذا يعني أن النتيجة قد لا تكون العنصر الأول في المجموعة الأصلية (من حيث الترتيب) الذي يمرر الاختبار. إذا كان الأمر ضمن المجموعة الأصلية مهمًا ، detectSeries إلى detectSeries .

الاسم المستعار:
تجد

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع قيمة منطقية كنتيجة لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee . ستكون النتيجة العنصر الأول في الصفيف الذي يمرر اختبار الحقيقة (iteratee) أو القيمة undefined إذا لم يتم تمرير أي. استدعى مع (يخطئ ، النتيجة).

مثال

async.detect(['file1','file2','file3'], function(filePath, callback) {
    fs.access(filePath, function(err) {
        callback(null, !err)
    });
}, function(err, result) {
    // result now equals the first file in the list that exists
});
مصدر:
detect.js ، السطر 7

(ثابت) detectLimit (coll، limit، iteratee، callback opt )

import detectLimit from 'async/detectLimit';

هو نفسه detect ولكنه يعمل بحد أقصى limit من عمليات async في كل مرة.

الاسم المستعار:
findLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع قيمة منطقية كنتيجة لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee . ستكون النتيجة العنصر الأول في الصفيف الذي يمرر اختبار الحقيقة (iteratee) أو القيمة undefined إذا لم يتم تمرير أي. استدعى مع (يخطئ ، النتيجة).

مصدر:
detectLimit.js ، السطر 7
نرى:

detect

(static) detectSeries (coll، iteratee، callback opt )

import detectSeries from 'async/detectSeries';

هو نفسه detect لكنه لا يعمل سوى عملية واحدة غير متزامنة في كل مرة.

الاسم المستعار:
findSeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

iteratee AsyncFunction

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع قيمة منطقية كنتيجة لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee . ستكون النتيجة العنصر الأول في الصفيف الذي يمرر اختبار الحقيقة (iteratee) أو القيمة undefined إذا لم يتم تمرير أي. استدعى مع (يخطئ ، النتيجة).

مصدر:
detectSeries.js ، السطر 4
نرى:

detect

(ثابت) لكل (coll، iteratee، callback opt )

import each from 'async/each';

يطبق الدالة iteratee على كل عنصر في coll ، بالتوازي. يتم استدعاء iteratee مع عنصر من القائمة ثم معاودة الاتصال عند الانتهاء. إذا قام iteratee بتمرير خطأ إلى callback به ، يتم callback الرئيسية ( each وظيفة) مع الخطأ على الفور.

لاحظ أنه بما أن هذه الوظيفة تنطبق على كل عنصر بالتوازي ، فلا يوجد ضمان بأن تكتمل وظائف التكرار بالترتيب.

الاسم المستعار:
forEach

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. استدعى مع (البند ، رد الاتصال). لا يتم تمرير فهرس الصفيف إلى iteratee. إذا كنت بحاجة إلى الفهرس ، استخدم eachOf .

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مثال

// assuming openFiles is an array of file names and saveFile is a function
// to save the modified contents of that file:

async.each(openFiles, saveFile, function(err){
  // if any of the saves produced an error, err would equal that error
});

// assuming openFiles is an array of file names
async.each(openFiles, function(file, callback) {

    // Perform operation on file here.
    console.log('Processing file ' + file);

    if( file.length > 32 ) {
      console.log('This file name is too long');
      callback('File name too long');
    } else {
      // Do work to process file here
      console.log('File processed');
      callback();
    }
}, function(err) {
    // if any of the file processing produced an error, err would equal that error
    if( err ) {
      // One of the iterations produced an error.
      // All processing will now stop.
      console.log('A file failed to process');
    } else {
      console.log('All files have been processed successfully');
    }
});
مصدر:
each.js ، السطر 5

(ثابت) لكلمتحدد (coll، limit، iteratee، callback opt )

import eachLimit from 'async/eachLimit';

تمامًا مثل each تشغيل عمليات limit async بحد أقصى في كل مرة.

الاسم المستعار:
forEachLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. لا يتم تمرير فهرس الصفيف إلى iteratee. إذا كنت في حاجة إلى الفهرس ، استخدم eachOfLimit . استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مصدر:
eachLimit.js ، السطر 5
نرى:

each

(ثابت) كل من (coll، iteratee، callback opt )

import eachOf from 'async/eachOf';

مثل each ، إلا أنه يمر المفتاح (أو الفهرس) كالوسيطة الثانية إلى iteratee.

الاسم المستعار:
forEachOf

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

iteratee AsyncFunction

وظيفة لتطبيقها على كل عنصر في المجموعة. key هو key العنصر ، أو الفهرس في حالة المصفوفة. استدعى مع (البند ، مفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مثال

var obj = {dev: "/dev.json", test: "/test.json", prod: "/prod.json"};
var configs = {};

async.forEachOf(obj, function (value, key, callback) {
    fs.readFile(__dirname + value, "utf8", function (err, data) {
        if (err) return callback(err);
        try {
            configs[key] = JSON.parse(data);
        } catch (e) {
            return callback(e);
        }
        callback();
    });
}, function (err) {
    if (err) console.error(err.message);
    // configs is now a map of JSON data
    doSomethingWith(configs);
});
مصدر:
eachOf.js ، السطر 37
نرى:

each

(ثابت) كلًا من الحد (coll ، limit ، iteratee ، callback opt )

import eachOfLimit from 'async/eachOfLimit';

هو نفسه eachOf ولكن يعمل بحد أقصى limit من عمليات async في كل مرة.

الاسم المستعار:
forEachOfLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. key هو key العنصر ، أو الفهرس في حالة المصفوفة. استدعى مع (البند ، مفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مصدر:
eachOfLimit.js ، السطر 4
نرى:

eachOf

(ثابت) eachOfSeries (coll، iteratee، callback opt )

import eachOfSeries from 'async/eachOfSeries';

نفس الشيء مثل كل eachOf ولكن يعمل فقط عملية واحدة غير eachOf في كل مرة.

الاسم المستعار:
forEachOfSeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. استدعى مع (البند ، مفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مصدر:
eachOfSeries.js ، السطر 4
نرى:

eachOf

(ثابت) eachSeries (coll، iteratee، callback opt )

import eachSeries from 'async/eachSeries';

نفس each تشغيل ولكن فقط عملية واحد غير متزامن في كل مرة.

الاسم المستعار:
forEachSeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. لا يتم تمرير فهرس الصفيف إلى iteratee. إذا كنت بحاجة إلى الفهرس ، فاستخدم eachOfSeries . استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. استدعى مع (يخطئ).

مصدر:
eachSeries.js ، السطر 4
نرى:

each

(ثابت) كل (coll، iteratee، callback opt )

import every from 'async/every';

إرجاع true إذا كان كل عنصر في المجموعة يفي بإجراء اختبار متزامن. في حالة إرجاع أي استدعاء iteratee false ، يتم callback الرئيسية مباشرةً.

الاسم المستعار:
الكل

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعة بالتوازي. يجب أن يتم إكمال iteratee مع قيمة نتيجة منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مثال

async.every(['file1','file2','file3'], function(filePath, callback) {
    fs.access(filePath, function(err) {
        callback(null, !err)
    });
}, function(err, result) {
    // if result is true then every file exists
});
مصدر:
every.js ، السطر 5

(ثابت) everyLimit (coll، limit، iteratee، callback opt )

import everyLimit from 'async/everyLimit';

كما هو الحال مع every عمليات الحد limit المتزامن limit في كل مرة.

الاسم المستعار:
allLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعة بالتوازي. يجب أن يتم إكمال iteratee مع قيمة نتيجة منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مصدر:
everyLimit.js ، السطر 5
نرى:

every

(ثابت) everySeries (coll، iteratee، callback opt )

import everySeries from 'async/everySeries';

نفس every عدا يدير عملية واحدة فقط في وقت واحد.

الاسم المستعار:
allSeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

اختبار اختبار التزامن لتطبيقه على كل عنصر في المجموعة في سلسلة. يجب أن يتم إكمال iteratee مع قيمة نتيجة منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مصدر:
everySeries.js ، السطر 4
نرى:

every

مرشح (ثابت) (coll، iteratee، callback opt )

import filter from 'async/filter';

تقوم بإرجاع مجموعة جديدة من كافة القيم في coll التي تمر باختبار للحقيقة غير متزامن. يتم تنفيذ هذه العملية بالتوازي ، لكن مصفوفة النتائج ستكون بنفس ترتيب الأصل.

الاسم المستعار:
تحديد

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee وظيفة

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يتم تمرير iteratee callback(err, truthValue) ، والذي يجب أن يسمى مع وسيطة منطقية بمجرد اكتمالها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى مع (يخطئ ، النتائج).

مثال

async.filter(['file1','file2','file3'], function(filePath, callback) {
    fs.access(filePath, function(err) {
        callback(null, !err)
    });
}, function(err, results) {
    // results now equals an array of the existing files
});
مصدر:
filter.js ، السطر 4

(ثابت) filterLimit (coll، limit، iteratee، callback opt )

import filterLimit from 'async/filterLimit';

نفس filter ولكنه يعمل بحد أقصى limit من عمليات async في كل مرة.

الاسم المستعار:
selectLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee وظيفة

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يتم تمرير iteratee callback(err, truthValue) ، والذي يجب أن يسمى مع وسيطة منطقية بمجرد اكتمالها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى مع (يخطئ ، النتائج).

مصدر:
filterLimit.js ، السطر 4
نرى:

filter

(ثابت) filterSeries (coll، iteratee، callback opt )

import filterSeries from 'async/filterSeries';

نفس filter ولكنه يعمل فقط عملية واحدة غير متزامنة في كل مرة.

الاسم المستعار:
selectSeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee وظيفة

اختبار الصدق لتطبيقه على كل عنصر في المجموعة. يتم تمرير iteratee callback(err, truthValue) ، والذي يجب أن يسمى مع وسيطة منطقية بمجرد اكتمالها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى (يخطئ ، النتائج)

مصدر:
filterSeries.js ، السطر 4
نرى:

filter

(ثابت) groupBy (coll، iteratee، callback opt )

import groupBy from 'async/groupBy';

إرجاع كائن جديد ، حيث تتطابق كل قيمة مع صفيف من العناصر ، من coll ، التي تعرض المفتاح المناظر. أي ، مفاتيح الكائن تتوافق مع القيم التي تم تمريرها إلى رد الاتصال iteratee .

ملاحظة: بما أن هذه الوظيفة تنطبق على كل عنصر بالتوازي ، فلا يوجد ضمان بأن iteratee وظائف iteratee بالترتيب. ومع ذلك ، ستكون القيم الخاصة بكل مفتاح في result بنفس ترتيب المجموعة الأصلية. بالنسبة إلى الكائنات ، ستكون القيم تقريبًا في ترتيب مفاتيح الكائنات الأصلية (ولكن يمكن أن يختلف ذلك عبر محركات JavaScript).

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع key لتجميع القيمة ضمن. استدعى مع (القيمة ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتيجة هي خصائص whoses Object هي صفائف القيم التي ترجع المفتاح المطابق.

مثال

async.groupBy(['userId1', 'userId2', 'userId3'], function(userId, callback) {
    db.findById(userId, function(err, user) {
        if (err) return callback(err);
        return callback(null, user.age);
    });
}, function(err, result) {
    // result is object containing the userIds grouped by age
    // e.g. { 30: ['userId1', 'userId3'], 42: ['userId2']};
});
مصدر:
groupBy.js ، السطر 4

(ثابتة) groupByLimit (coll، limit، iteratee، callback opt )

import groupByLimit from 'async/groupByLimit';

كما هو groupBy مع groupBy ولكن يتم تشغيل عمليات limit async بحد أقصى في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع key لتجميع القيمة ضمن. استدعى مع (القيمة ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتيجة هي خصائص whoses Object هي صفائف القيم التي ترجع المفتاح المطابق.

مصدر:
groupByLimit.js ، السطر 4
نرى:

groupBy

(ثابتة) groupBySeries (coll، limit، iteratee، callback opt )

import groupBySeries from 'async/groupBySeries';

كما هو groupBy مع groupBy ولكن لا يعمل سوى عملية واحدة غير groupBy في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يتم إكمال iteratee مع key لتجميع القيمة ضمن. استدعى مع (القيمة ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتيجة هي خصائص whoses Object هي صفائف القيم التي ترجع المفتاح المطابق.

مصدر:
groupBySeries.js ، السطر 4
نرى:

groupBy

(ثابت) خريطة (coll، iteratee، callback opt )

import map from 'async/map';

ينتج مجموعة جديدة من القيم عن طريق تعيين كل قيمة في coll خلال الدالة iteratee . يتم استدعاء iteratee مع عنصر من coll و callback عند الانتهاء من المعالجة. يأخذ كل من هذه الاستدعاءات وسيطتين: error ، والبند الذي تم تحويله من coll . إذا قام iteratee بتمرير خطأ إلى معاودة الاتصال به ، iteratee استدعاء معاودة الاتصال الرئيسية (لوظيفة map ) مع الخطأ على الفور.

لاحظ أنه بما أن هذه الوظيفة تنطبق على كل عنصر بالتوازي ، فلا يوجد ضمان بأن iteratee وظائف iteratee بالترتيب. ومع ذلك ، فإن مصفوفة النتائج ستكون بنفس ترتيب المجموعة الأصلية.

إذا تم تمرير map كائن ، ستكون النتائج صفيف. ستكون النتائج تقريبًا في ترتيب مفاتيح الكائنات الأصلية (ولكن يمكن أن يختلف ذلك عبر محركات JavaScript).

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يكتمل iteratee مع العنصر الذي تم تحويله. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتائج عبارة عن صفيف من العناصر المحولة من coll . استدعى مع (يخطئ ، النتائج).

مثال

async.map(['file1','file2','file3'], fs.stat, function(err, results) {
    // results is now an array of stats for each file
});
مصدر:
map.js ، السطر 4

(ثابت) mapLimit (coll، limit، iteratee، callback opt )

import mapLimit from 'async/mapLimit';

كما هو الحال مع map ولكن يتم تشغيل عمليات limit متزامن كحد أقصى في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يكتمل iteratee مع العنصر الذي تم تحويله. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتائج هي مجموعة من العناصر المحولة من المجموعة. استدعى مع (يخطئ ، النتائج).

مصدر:
mapLimit.js ، السطر 4
نرى:

map

(ثابتة) mapSeries (coll، iteratee، callback opt )

import mapSeries from 'async/mapSeries';

نفس map ولكن يعمل فقط عملية واحد غير متزامن في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يكتمل iteratee مع العنصر الذي تم تحويله. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. النتائج هي مجموعة من العناصر المحولة من المجموعة. استدعى مع (يخطئ ، النتائج).

مصدر:
mapSeries.js ، السطر 4
نرى:

map

(ثابت) mapValues ​​(obj، iteratee، callback opt )

import mapValues from 'async/mapValues';

أحد أقارب map ، مصمم للاستخدام مع الكائنات.

ينتج عن كائن جديد عن طريق تعيين كل قيمة obj من خلال الدالة iteratee . يسمى iteratee كل value key من obj و callback عند الانتهاء من المعالجة. تأخذ كل من هذه الاسترجاعات وسيطتين: error ، obj تحويله من obj . إذا قام iteratee بتمرير خطأ إلى معاودة الاتصال به ، mapValues callback الرئيسية (الخاصة بوظيفة mapValues ) مع الخطأ على الفور.

لاحظ ، لا يتم ضمان ترتيب المفاتيح في النتيجة. ستكون المفاتيح تقريبًا حسب الترتيب الذي أكملته ، (لكن هذا الأمر يتعلق بالمحرك)

المعلمات:

اسم اكتب وصف
obj موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة للتطبيق على كل قيمة ومفتاح في coll . يجب أن يتم إكمال iteratee مع القيمة التي تم تحويلها كنتيجة. استدعى مع (القيمة ، المفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. result هي كائن جديد يتألف من كل مفتاح من obj ، مع كل قيمة محولة على الجانب الأيمن. استدعى مع (يخطئ ، النتيجة).

مثال

async.mapValues({
    f1: 'file1',
    f2: 'file2',
    f3: 'file3'
}, function (file, key, callback) {
  fs.stat(file, callback);
}, function(err, result) {
    // result is now a map of stats for each file, e.g.
    // {
    //     f1: [stats for file1],
    //     f2: [stats for file2],
    //     f3: [stats for file3]
    // }
});
مصدر:
mapValues.js ، السطر 5

(ثابت) mapValuesLimit (obj، limit، iteratee، callback opt )

import mapValuesLimit from 'async/mapValuesLimit';

مثل mapValues ولكنه يعمل بحد أقصى limit من عمليات async في كل مرة.

المعلمات:

اسم اكتب وصف
obj موضوع

مجموعة لتكرار أكثر.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

وظيفة للتطبيق على كل قيمة ومفتاح في coll . يجب أن يتم إكمال iteratee مع القيمة التي تم تحويلها كنتيجة. استدعى مع (القيمة ، المفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. result هي كائن جديد يتألف من كل مفتاح من obj ، مع كل قيمة محولة على الجانب الأيمن. استدعى مع (يخطئ ، النتيجة).

مصدر:
mapValuesLimit.js ، السطر 7
نرى:

mapValues

(ثابت) mapValuesSeries (obj، iteratee، callback opt )

import mapValuesSeries from 'async/mapValuesSeries';

مثل mapValues ولكنه لا يعمل سوى عملية واحدة غير mapValues في كل مرة.

المعلمات:

اسم اكتب وصف
obj موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

وظيفة للتطبيق على كل قيمة ومفتاح في coll . يجب أن يتم إكمال iteratee مع القيمة التي تم تحويلها كنتيجة. استدعى مع (القيمة ، المفتاح ، رد الاتصال).

callback وظيفة <اختياري>

رد اتصال يسمى عند iteratee جميع وظائف iteratee ، أو حدوث خطأ. result هي كائن جديد يتألف من كل مفتاح من obj ، مع كل قيمة محولة على الجانب الأيمن. استدعى مع (يخطئ ، النتيجة).

مصدر:
mapValuesSeries.js ، السطر 4
نرى:

mapValues

(ثابت) تقليل (coll، memo، iteratee، callback opt )

import reduce from 'async/reduce';

يخفض iteratee إلى قيمة واحدة باستخدام iteratee لإرجاع كل خطوة متتالية. memo هي الحالة الأولية للتخفيض. هذه الوظيفة تعمل فقط في سلسلة.

لأسباب تتعلق بالأداء ، قد يكون من المنطقي تقسيم استدعاء لهذه الوظيفة إلى خريطة متوازية ، ثم استخدام النموذج Array.prototype.reduce العادي في النتائج. هذه الوظيفة هي الحالات التي تحتاج فيها كل خطوة في التخفيض إلى التزامن ؛ إذا كان بإمكانك الحصول على البيانات قبل تقليلها ، فمن المحتمل أن تكون فكرة جيدة للقيام بذلك.

الاسم المستعار:
foldl

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

memo *

الحالة الأولية للتخفيض.

iteratee AsyncFunction

دالة يتم تطبيقها على كل عنصر في المصفوفة لإنتاج الخطوة التالية في الخفض. يجب أن يتم إكمال iteratee مع الحالة التالية من التخفيض. إذا تم إكمال iteratee مع وجود خطأ ، يتم إيقاف التخفيض ويتم callback الرئيسي مباشرة مع الخطأ. استدعى مع (مذكرة ، البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . النتيجة هي انخفاض القيمة. استدعى مع (يخطئ ، النتيجة).

مثال

async.reduce([1,2,3], 0, function(memo, item, callback) {
    // pointless async:
    process.nextTick(function() {
        callback(null, memo + item)
    });
}, function(err, result) {
    // result is now equal to the last value of memo, which is 6
});
مصدر:
reduce.js ، السطر 6

(ثابت) تقليلRight (الصفيف ، المذكرة ، iteratee ، اختيار رد)

import reduceRight from 'async/reduceRight';

مثل reduce ، يعمل فقط على array في ترتيب عكسي.

الاسم المستعار:
foldr

المعلمات:

اسم اكتب وصف
array مجموعة مصفوفة

مجموعة لتكرار أكثر.

memo *

الحالة الأولية للتخفيض.

iteratee AsyncFunction

دالة يتم تطبيقها على كل عنصر في المصفوفة لإنتاج الخطوة التالية في الخفض. يجب أن يتم إكمال iteratee مع الحالة التالية من التخفيض. إذا تم إكمال iteratee مع وجود خطأ ، يتم إيقاف التخفيض ويتم callback الرئيسي مباشرة مع الخطأ. استدعى مع (مذكرة ، البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . النتيجة هي انخفاض القيمة. استدعى مع (يخطئ ، النتيجة).

مصدر:
reduceRight.js ، السطر 4
نرى:

reduce

(ثابت) رفض (coll، iteratee، callback opt )

import reject from 'async/reject';

عكس filter . يزيل القيم التي تمر باختبار الحقيقة async .

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee وظيفة

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعة. يجب أن تكتمل القيمة المنطقية result لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى مع (يخطئ ، النتائج).

مثال

async.reject(['file1','file2','file3'], function(filePath, callback) {
    fs.access(filePath, function(err) {
        callback(null, !err)
    });
}, function(err, results) {
    // results now equals an array of missing files
    createFiles(results);
});
مصدر:
reject.js ، السطر 4
نرى:

filter

(ثابت) rejectLimit (coll، limit، iteratee، callback opt )

import rejectLimit from 'async/rejectLimit';

مثل reject ولكن تشغيل عمليات async limit في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee وظيفة

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعة. يجب أن تكتمل القيمة المنطقية result لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى مع (يخطئ ، النتائج).

مصدر:
rejectLimit.js ، السطر 4
نرى:

reject

(static) rejectSeries (coll، iteratee، callback opt )

import rejectSeries from 'async/rejectSeries';

نفس reject ولكن تشغيل عملية متزامن واحد فقط في كل مرة.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

iteratee وظيفة

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعة. يجب أن تكتمل القيمة المنطقية result لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

تم الانتهاء من استدعاء الذي يسمى بعد كافة دالات iteratee . استدعى مع (يخطئ ، النتائج).

مصدر:
rejectSeries.js ، السطر 4
نرى:

reject

(ثابت) بعض (coll، iteratee، callback opt )

import some from 'async/some';

إرجاع true إذا كان هناك عنصر واحد على الأقل في المجموعة يلبي اختبارًا غير متزامن. إذا كان أي استدعاء iteratee بإرجاع true ، يتم callback الرئيسي مباشرة.

الاسم المستعار:
أي

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

iteratee AsyncFunction

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعات بالتوازي. يجب أن يتم إكمال iteratee مع قيمة result منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee. ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مثال

async.some(['file1','file2','file3'], function(filePath, callback) {
    fs.access(filePath, function(err) {
        callback(null, !err)
    });
}, function(err, result) {
    // if result is true then at least one of the files exists
});
مصدر:
some.js ، السطر 5

(ثابت) someLimit (coll، limit، iteratee، callback opt )

import someLimit from 'async/someLimit';

نفس مثل some ولكن تشغيل عمليات async limit في كل مرة.

الاسم المستعار:
anyLimit

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

limit رقم

الحد الأقصى لعدد عمليات المتزامن في كل مرة.

iteratee AsyncFunction

اختبار متزامن للحقيقة للتطبيق على كل عنصر في المجموعات بالتوازي. يجب أن يتم إكمال iteratee مع قيمة result منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee. ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مصدر:
someLimit.js ، السطر 5
نرى:

some

(ثابت) someSeries (coll، iteratee، callback opt )

import someSeries from 'async/someSeries';

نفس مثل some ولكن تشغيل عملية متزامن واحد فقط في كل مرة.

الاسم المستعار:
anySeries

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

iteratee AsyncFunction

اختبار اختبار التزامن لتطبيقه على كل عنصر في مجموعات المجموعات. يجب أن يتم إكمال iteratee مع قيمة result منطقية. استدعى مع (البند ، رد الاتصال).

callback وظيفة <اختياري>

رد الاتصال الذي يسمى بمجرد أي iteratee بإرجاع true أو بعد انتهاء كافة دالات iteratee. ستكون النتيجة إما true أو false وفقًا لقيم اختبارات التزامن. استدعى مع (يخطئ ، النتيجة).

مصدر:
someSeries.js ، السطر 4
نرى:

some

(ثابتة) sortBy (coll، iteratee، callback)

import sortBy from 'async/sortBy';

لفرز قائمة حسب نتائج تشغيل كل قيمة iteratee خلال متزامن iteratee .

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرارها.

iteratee AsyncFunction

وظيفة متزامن لتطبيقها على كل عنصر في المجموعة. يجب أن يكمل iteratee بقيمة لاستخدامها كمعايير الفرز result لها. استدعى مع (البند ، رد الاتصال).

callback وظيفة

تم إجراء رد اتصال يسمى بعد إنهاء كافة دالات iteratee أو حدوث خطأ. النتائج هي العناصر الموجودة في المجموعة الأصلية مرتبة حسب القيم التي يتم إرجاعها بواسطة مكالمات iteratee . استدعى مع (يخطئ ، النتائج).

مثال

async.sortBy(['file1','file2','file3'], function(file, callback) {
    fs.stat(file, function(err, stats) {
        callback(err, stats.mtime);
    });
}, function(err, results) {
    // results is now the original array of files sorted by
    // modified date
});

// By modifying the callback parameter the
// sorting order can be influenced:

// ascending order
async.sortBy([1,9,3,5], function(x, callback) {
    callback(null, x);
}, function(err,result) {
    // result callback
});

// descending order
async.sortBy([1,9,3,5], function(x, callback) {
    callback(null, x*-1);    //<- x*-1 instead of x, turns the order around
}, function(err,result) {
    // result callback
});
مصدر:
sortBy.js ، السطر 7

تحويل (ثابت) (coll، optulator opt ، iteratee، callback opt )

import transform from 'async/transform';

قريب من reduce . يأخذ كائنًا أو صفيفًا ، ويتكرر عبر كل عنصر في السلسلة ، كل خطوة يحتمل أن تكون متحولة لقيمة accumulator . نوع المخزن الافتراضي إلى نوع المجموعة التي تم تمريرها.

المعلمات:

اسم اكتب وصف
coll صفيف | متكرر | موضوع

مجموعة لتكرار أكثر.

accumulator * <اختياري>

الحالة الأولية للتحويل. إذا تم تجاهله ، فسيتم افتراضيًا إلى كائن أو مصفوفة فارغة ، وفقًا لنوع coll

iteratee AsyncFunction

دالة مطبقة على كل عنصر في المجموعة يحتمل أن تعدّل تراكم البيانات. Invoked with (accumulator, item, key, callback).

callback function <optional>

A callback which is called after all the iteratee functions have finished. Result is the transformed accumulator. Invoked with (err, result).

أمثلة

async.transform([1,2,3], function(acc, item, index, callback) {
    // pointless async:
    process.nextTick(function() {
        acc.push(item * 2)
        callback(null)
    });
}, function(err, result) {
    // result is now equal to [2, 4, 6]
});
async.transform({a: 1, b: 2, c: 3}, function (obj, val, key, callback) {
    setImmediate(function () {
        obj[key] = val * 2;
        callback();
    })
}, function (err, result) {
    // result is equal to {a: 2, b: 4, c: 6}
})
مصدر:
transform.js , line 8

Control Flow

A collection of async functions for controlling the flow through a script.

مصدر:
index.js , line 56

أساليب

(static) applyEach(fns, …args opt , callback opt ) â†' {function}

import applyEach from 'async/applyEach';

Applies the provided arguments to each function in the array, calling callback after all functions have completed. If you only provide the first argument, fns , then it will return a function which lets you pass in the arguments as if it were a single function call. If more arguments are provided, callback is required while args is still optional.

المعلمات:

اسم اكتب وصف
fns Array | Iterable | موضوع

A collection of AsyncFunction s to all call with the same arguments

args * <optional>

any number of separate arguments to pass to the function.

callback function <optional>

the final argument should be the callback, called when all functions have completed processing.

عائدات:

  • If only the first argument, fns , is provided, it will return a function which lets you pass in the arguments as if it were a single function call. The signature is (..args, callback) . If invoked with any arguments, callback is required.
اكتب
function

مثال

async.applyEach([enableSearch, updateSchema], 'bucket', callback);

// partial application example:
async.each(
    buckets,
    async.applyEach([enableSearch, updateSchema]),
    callback
);
مصدر:
applyEach.js , line 4

(static) applyEachSeries(fns, …args opt , callback opt ) â†' {function}

import applyEachSeries from 'async/applyEachSeries';

The same as applyEach but runs only a single async operation at a time.

المعلمات:

اسم اكتب وصف
fns Array | Iterable | موضوع

A collection of AsyncFunction s to all call with the same arguments

args * <optional>

any number of separate arguments to pass to the function.

callback function <optional>

the final argument should be the callback, called when all functions have completed processing.

عائدات:

  • If only the first argument is provided, it will return a function which lets you pass in the arguments as if it were a single function call.
اكتب
function
مصدر:
applyEachSeries.js , line 4
نرى:

applyEach

(static) auto(tasks, concurrency opt , callback opt )

import auto from 'async/auto';

Determines the best order for running the AsyncFunction s in tasks , based on their requirements. Each function can optionally depend on other functions being completed first, and each function is run as soon as its requirements are satisfied.

If any of the AsyncFunction s pass an error to their callback, the auto sequence will stop. Further tasks will not execute (so any other functions depending on it will not run), and the main callback is immediately called with the error.

AsyncFunction s also receive an object containing the results of functions which have completed so far as the first argument, if they have dependencies. If a task function has no dependencies, it will only be passed a callback.

المعلمات:

اسم اكتب افتراضي وصف
tasks موضوع

An object. Each of its properties is either a function or an array of requirements, with the AsyncFunction itself the last item in the array. The object's key of a property serves as the name of the task defined by that property, ie can be used when specifying requirements for other tasks. The function receives one or two arguments:

  • a results object, containing the results of the previously executed functions, only passed if the task has any dependencies,
  • a callback(err, result) function, which must be called when finished, passing an error (which can be null ) and the result of the function's execution.
concurrency number <optional> ما لا نهاية

An optional integer for determining the maximum number of tasks that can be run in parallel. By default, as many as possible.

callback function <optional>

An optional callback which is called when all the tasks have been completed. It receives the err argument if any tasks pass an error to their callback. Results are always returned; however, if an error occurs, no further tasks will be performed, and the results object will only contain partial results. Invoked with (err, results).

عائدات:

غير محدد

مثال

async.auto({
    // this function will just be passed a callback
    readData: async.apply(fs.readFile, 'data.txt', 'utf-8'),
    showData: ['readData', function(results, cb) {
        // results.readData is the file's contents
        // ...
    }]
}, callback);

async.auto({
    get_data: function(callback) {
        console.log('in get_data');
        // async code to get some data
        callback(null, 'data', 'converted to array');
    },
    make_folder: function(callback) {
        console.log('in make_folder');
        // async code to create a directory to store a file in
        // this is run at the same time as getting the data
        callback(null, 'folder');
    },
    write_file: ['get_data', 'make_folder', function(results, callback) {
        console.log('in write_file', JSON.stringify(results));
        // once there is some data and the directory exists,
        // write the data to a file in the directory
        callback(null, 'filename');
    }],
    email_link: ['write_file', function(results, callback) {
        console.log('in email_link', JSON.stringify(results));
        // once the file is written let's email a link to it...
        // results.write_file contains the filename returned by write_file.
        callback(null, {'file':results.write_file, 'email':'[email protected]'});
    }]
}, function(err, results) {
    console.log('err = ', err);
    console.log('results = ', results);
});
مصدر:
auto.js , line 13

(static) autoInject(tasks, callback opt )

import autoInject from 'async/autoInject';

A dependency-injected version of the async.auto function. Dependent tasks are specified as parameters to the function, after the usual callback parameter, with the parameter names matching the names of the tasks it depends on. This can provide even more readable task graphs which can be easier to maintain.

If a final callback is specified, the task results are similarly injected, specified as named parameters after the initial error parameter.

The autoInject function is purely syntactic sugar and its semantics are otherwise equivalent to async.auto .

المعلمات:

اسم اكتب وصف
tasks موضوع

An object, each of whose properties is an AsyncFunction of the form 'func([dependencies...], callback). The object's key of a property serves as the name of the task defined by that property, ie can be used when specifying requirements for other tasks.

  • The callback parameter is a callback(err, result) which must be called when finished, passing an error (which can be null ) and the result of the function's execution. The remaining parameters name other tasks on which the task is dependent, and the results from those tasks are the arguments of those parameters.
callback function <optional>

An optional callback which is called when all the tasks have been completed. It receives the err argument if any tasks pass an error to their callback, and a results object with any completed task results, similar to auto .

مثال

//  The example from `auto` can be rewritten as follows:
async.autoInject({
    get_data: function(callback) {
        // async code to get some data
        callback(null, 'data', 'converted to array');
    },
    make_folder: function(callback) {
        // async code to create a directory to store a file in
        // this is run at the same time as getting the data
        callback(null, 'folder');
    },
    write_file: function(get_data, make_folder, callback) {
        // once there is some data and the directory exists,
        // write the data to a file in the directory
        callback(null, 'filename');
    },
    email_link: function(write_file, callback) {
        // once the file is written let's email a link to it...
        // write_file contains the filename returned by write_file.
        callback(null, {'file':write_file, 'email':'[email protected]'});
    }
}, function(err, results) {
    console.log('err = ', err);
    console.log('email_link = ', results.email_link);
});

// If you are using a JS minifier that mangles parameter names, `autoInject`
// will not work with plain functions, since the parameter names will be
// collapsed to a single letter identifier.  To work around this, you can
// explicitly specify the names of the parameters your task function needs
// in an array, similar to Angular.js dependency injection.

// This still has an advantage over plain `auto`, since the results a task
// depends on are still spread into arguments.
async.autoInject({
    //...
    write_file: ['get_data', 'make_folder', function(get_data, make_folder, callback) {
        callback(null, 'filename');
    }],
    email_link: ['write_file', function(write_file, callback) {
        callback(null, {'file':write_file, 'email':'[email protected]'});
    }]
    //...
}, function(err, results) {
    console.log('err = ', err);
    console.log('email_link = ', results.email_link);
});
مصدر:
autoInject.js , line 24
نرى:

async.auto

(static) cargo(worker, payload opt ) â†' { CargoObject }

import cargo from 'async/cargo';

Creates a cargo object with the specified payload. Tasks added to the cargo will be processed altogether (up to the payload limit). If the worker is in progress, the task is queued until it becomes available. Once the worker has completed some tasks, each callback of those tasks is called. Check out these animations for how cargo and queue work.

While queue passes only one task to one of a group of workers at a time, cargo passes an array of tasks to a single worker, repeating when the worker is finished.

المعلمات:

اسم اكتب افتراضي وصف
worker AsyncFunction

An asynchronous function for processing an array of queued tasks. Invoked with (tasks, callback) .

payload number <optional> ما لا نهاية

An optional integer for determining how many tasks should be processed per round; if omitted, the default is unlimited.

عائدات:

A cargo object to manage the tasks. Callbacks can attached as certain properties to listen for specific events during the lifecycle of the cargo and inner queue.

اكتب
CargoObject

مثال

// create a cargo object with payload 2
var cargo = async.cargo(function(tasks, callback) {
    for (var i=0; i<tasks.length; i++) {
        console.log('hello ' + tasks[i].name);
    }
    callback();
}, 2);

// add some items
cargo.push({name: 'foo'}, function(err) {
    console.log('finished processing foo');
});
cargo.push({name: 'bar'}, function(err) {
    console.log('finished processing bar');
});
cargo.push({name: 'baz'}, function(err) {
    console.log('finished processing baz');
});
مصدر:
cargo.js , line 33
نرى:

queue

(static) compose(…functions) â†' {function}

import compose from 'async/compose';

Creates a function which is a composition of the passed asynchronous functions. Each function consumes the return value of the function that follows. Composing functions f() , g() , and h() would produce the result of f(g(h())) , only this version uses callbacks to obtain the return values.

Each function is executed with the this binding of the composed function.

المعلمات:

اسم اكتب وصف
functions AsyncFunction

the asynchronous functions to compose

عائدات:

an asynchronous function that is the composed asynchronous functions

اكتب
function

مثال

function add1(n, callback) {
    setTimeout(function () {
        callback(null, n + 1);
    }, 10);
}

function mul3(n, callback) {
    setTimeout(function () {
        callback(null, n * 3);
    }, 10);
}

var add1mul3 = async.compose(mul3, add1);
add1mul3(4, function (err, result) {
    // result now equals 15
});
مصدر:
compose.js , line 4

(static) doDuring(fn, test, callback opt )

import doDuring from 'async/doDuring';

The post-check version of during . To reflect the difference in the order of operations, the arguments test and fn are switched.

Also a version of doWhilst with asynchronous test function.

المعلمات:

اسم اكتب وصف
fn AsyncFunction

An async function which is called each time test passes. Invoked with (callback).

test AsyncFunction

asynchronous truth test to perform before each execution of fn . Invoked with (...args, callback), where ...args are the non-error args from the previous callback of fn .

callback function <optional>

A callback which is called after the test function has failed and repeated execution of fn has stopped. callback will be passed an error if one occurred, otherwise null .

مصدر:
doDuring.js , line 6
نرى:

during

(static) doUntil(iteratee, test, callback opt )

import doUntil from 'async/doUntil';

Like doWhilst , except the test is inverted. Note the argument ordering differs from until .

المعلمات:

اسم اكتب وصف
iteratee AsyncFunction

An async function which is called each time test fails. Invoked with (callback).

test function

synchronous truth test to perform after each execution of iteratee . Invoked with any non-error callback results of iteratee .

callback function <optional>

A callback which is called after the test function has passed and repeated execution of iteratee has stopped. callback will be passed an error and any arguments passed to the final iteratee 's callback. Invoked with (err, [results]);

مصدر:
doUntil.js , line 3
نرى:

doWhilst

(static) doWhilst(iteratee, test, callback opt )

import doWhilst from 'async/doWhilst';

The post-check version of whilst . To reflect the difference in the order of operations, the arguments test and iteratee are switched.

doWhilst is to whilst as do while is to while in plain JavaScript.

المعلمات:

اسم اكتب وصف
iteratee AsyncFunction

A function which is called each time test passes. Invoked with (callback).

test function

synchronous truth test to perform after each execution of iteratee . Invoked with any non-error callback results of iteratee .

callback function <optional>

A callback which is called after the test function has failed and repeated execution of iteratee has stopped. callback will be passed an error and any arguments passed to the final iteratee 's callback. Invoked with (err, [results]);

مصدر:
doWhilst.js , line 7
نرى:

whilst

(static) during(test, fn, callback opt )

import during from 'async/during';

Like whilst , except the test is an asynchronous function that is passed a callback in the form of function (err, truth) . If error is passed to test or fn , the main callback is immediately called with the value of the error.

المعلمات:

اسم اكتب وصف
test AsyncFunction

asynchronous truth test to perform before each execution of fn . Invoked with (callback).

fn AsyncFunction

An async function which is called each time test passes. Invoked with (callback).

callback function <optional>

A callback which is called after the test function has failed and repeated execution of fn has stopped. callback will be passed an error, if one occurred, otherwise null .

مثال

var count = 0;

async.during(
    function (callback) {
        return callback(null, count < 5);
    },
    function (callback) {
        count++;
        setTimeout(callback, 1000);
    },
    function (err) {
        // 5 seconds have passed
    }
);
مصدر:
during.js , line 5
نرى:

whilst

(static) forever(fn, errback opt )

import forever from 'async/forever';

Calls the asynchronous function fn with a callback parameter that allows it to call itself again, in series, indefinitely. If an error is passed to the callback then errback is called with the error, and execution stops, otherwise it will never be called.

المعلمات:

اسم اكتب وصف
fn AsyncFunction

an async function to call repeatedly. Invoked with (next).

errback function <optional>

when fn passes an error to it's callback, this function will be called, and execution stops. Invoked with (err).

مثال

async.forever(
    function(next) {
        // next is suitable for passing to things that need a callback(err [, whatever]);
        // it will result in this function being called again.
    },
    function(err) {
        // if next is called with a value in its first parameter, it will appear
        // in here as 'err', and execution will stop.
    }
);
مصدر:
forever.js , line 7

(static) parallel(tasks, callback opt )

import parallel from 'async/parallel';

Run the tasks collection of functions in parallel, without waiting until the previous function has completed. If any of the functions pass an error to its callback, the main callback is immediately called with the value of the error. Once the tasks have completed, the results are passed to the final callback as an array.

Note: parallel is about kicking-off I/O tasks in parallel, not about parallel execution of code. If your tasks do not use any timers or perform any I/O, they will actually be executed in series. Any synchronous setup sections for each task will happen one after the other. JavaScript remains single-threaded.

Hint: Use reflect to continue the execution of other tasks when a task fails.

It is also possible to use an object instead of an array. Each property will be run as a function and the results will be passed to the final callback as an object instead of an array. This can be a more readable way of handling results from async.parallel.

المعلمات:

اسم اكتب وصف
tasks Array | Iterable | موضوع

A collection of AsyncFunction to run. Each async function can complete with any number of optional result values.

callback function <optional>

An optional callback to run once all the functions have completed successfully. This function gets a results array (or object) containing all the result arguments passed to the task callbacks. Invoked with (err, results).

مثال

async.parallel([
    function(callback) {
        setTimeout(function() {
            callback(null, 'one');
        }, 200);
    },
    function(callback) {
        setTimeout(function() {
            callback(null, 'two');
        }, 100);
    }
],
// optional callback
function(err, results) {
    // the results array will equal ['one','two'] even though
    // the second function had a shorter timeout.
});

// an example using an object instead of an array
async.parallel({
    one: function(callback) {
        setTimeout(function() {
            callback(null, 1);
        }, 200);
    },
    two: function(callback) {
        setTimeout(function() {
            callback(null, 2);
        }, 100);
    }
}, function(err, results) {
    // results is now equals to: {one: 1, two: 2}
});
مصدر:
parallel.js , line 4

(static) parallelLimit(tasks, limit, callback opt )

import parallelLimit from 'async/parallelLimit';

The same as parallel but runs a maximum of limit async operations at a time.

المعلمات:

اسم اكتب وصف
tasks Array | Iterable | موضوع

A collection of AsyncFunction to run. Each async function can complete with any number of optional result values.

limit number

The maximum number of async operations at a time.

callback function <optional>

An optional callback to run once all the functions have completed successfully. This function gets a results array (or object) containing all the result arguments passed to the task callbacks. Invoked with (err, results).

مصدر:
parallelLimit.js , line 4
نرى:

parallel

(static) priorityQueue(worker, concurrency) â†' { QueueObject }

import priorityQueue from 'async/priorityQueue';

The same as queue only tasks are assigned a priority and completed in ascending priority order.

المعلمات:

اسم اكتب وصف
worker AsyncFunction

An async function for processing a queued task. If you want to handle errors from an individual task, pass a callback to q.push() . Invoked with (task, callback).

concurrency number

An integer for determining how many worker functions should be run in parallel. If omitted, the concurrency defaults to 1 . If the concurrency is 0 , an error is thrown.

عائدات:

A priorityQueue object to manage the tasks. There are two differences between queue and priorityQueue objects:

  • push(task, priority, [callback]) - priority should be a number. If an array of tasks is given, all tasks will be assigned the same priority.
  • The unshift method was removed.
اكتب
QueueObject
مصدر:
priorityQueue.js , line 8
نرى:

queue

(static) queue(worker, concurrency opt ) â†' { QueueObject }

import queue from 'async/queue';

Creates a queue object with the specified concurrency . Tasks added to the queue are processed in parallel (up to the concurrency limit). If all worker s are in progress, the task is queued until one becomes available. Once a worker completes a task , that task 's callback is called.

المعلمات:

اسم اكتب افتراضي وصف
worker AsyncFunction

An async function for processing a queued task. If you want to handle errors from an individual task, pass a callback to q.push() . Invoked with (task, callback).

concurrency number <optional> 1

An integer for determining how many worker functions should be run in parallel. If omitted, the concurrency defaults to 1 . If the concurrency is 0 , an error is thrown.

عائدات:

A queue object to manage the tasks. Callbacks can attached as certain properties to listen for specific events during the lifecycle of the queue.

اكتب
QueueObject

مثال

// create a queue object with concurrency 2
var q = async.queue(function(task, callback) {
    console.log('hello ' + task.name);
    callback();
}, 2);

// assign a callback
q.drain = function() {
    console.log('all items have been processed');
};

// add some items to the queue
q.push({name: 'foo'}, function(err) {
    console.log('finished processing foo');
});
q.push({name: 'bar'}, function (err) {
    console.log('finished processing bar');
});

// add some items to the queue (batch-wise)
q.push([{name: 'baz'},{name: 'bay'},{name: 'bax'}], function(err) {
    console.log('finished processing item');
});

// add some items to the front of the queue
q.unshift({name: 'bar'}, function (err) {
    console.log('finished processing bar');
});
مصدر:
queue.js , line 58

(static) race(tasks, callback)

import race from 'async/race';

Runs the tasks array of functions in parallel, without waiting until the previous function has completed. Once any of the tasks complete or pass an error to its callback, the main callback is immediately called. It's equivalent to Promise.race() .

المعلمات:

اسم اكتب وصف
tasks مجموعة مصفوفة

An array containing AsyncFunction to run. Each function can complete with an optional result value.

callback function

A callback to run once any of the functions have completed. This function gets an error or result from the first function that completed. Invoked with (err, result).

عائدات:

غير محدد

مثال

async.race([
    function(callback) {
        setTimeout(function() {
            callback(null, 'one');
        }, 200);
    },
    function(callback) {
        setTimeout(function() {
            callback(null, 'two');
        }, 100);
    }
],
// main callback
function(err, result) {
    // the result will be equal to 'two' as it finishes earlier
});
مصدر:
race.js , line 6

(static) retry(opts opt , task, callback opt )

import retry from 'async/retry';

Attempts to get a successful response from task no more than times times before returning an error. If the task is successful, the callback will be passed the result of the successful task. If all attempts fail, the callback will be passed the error and result (if any) of the final attempt.

المعلمات:

اسم اكتب افتراضي وصف
opts Object | number <optional> {times: 5, interval: 0}| 5

Can be either an object with times and interval or a number.

  • times - The number of attempts to make before giving up. The default is 5 .
  • interval - The time to wait between retries, in milliseconds. The default is 0 . The interval may also be specified as a function of the retry count (see example).
  • errorFilter - An optional synchronous function that is invoked on erroneous result. If it returns true the retry attempts will continue; if the function returns false the retry flow is aborted with the current attempt's error and result being returned to the final callback. Invoked with (err).
  • If opts is a number, the number specifies the number of times to retry, with the default interval of 0 .
task AsyncFunction

An async function to retry. Invoked with (callback).

callback function <optional>

An optional callback which is called when the task has succeeded, or after the final failed attempt. It receives the err and result arguments of the last attempt at completing the task . Invoked with (err, results).

مثال

// The `retry` function can be used as a stand-alone control flow by passing
// a callback, as shown below:

// try calling apiMethod 3 times
async.retry(3, apiMethod, function(err, result) {
    // do something with the result
});

// try calling apiMethod 3 times, waiting 200 ms between each retry
async.retry({times: 3, interval: 200}, apiMethod, function(err, result) {
    // do something with the result
});

// try calling apiMethod 10 times with exponential backoff
// (i.e. intervals of 100, 200, 400, 800, 1600, ... milliseconds)
async.retry({
  times: 10,
  interval: function(retryCount) {
    return 50 * Math.pow(2, retryCount);
  }
}, apiMethod, function(err, result) {
    // do something with the result
});

// try calling apiMethod the default 5 times no delay between each retry
async.retry(apiMethod, function(err, result) {
    // do something with the result
});

// try calling apiMethod only when error condition satisfies, all other
// errors will abort the retry control flow and return to final callback
async.retry({
  errorFilter: function(err) {
    return err.message === 'Temporary error'; // only retry on a specific error
  }
}, apiMethod, function(err, result) {
    // do something with the result
});

// to retry individual methods that are not as reliable within other
// control flow functions, use the `retryable` wrapper:
async.auto({
    users: api.getUsers.bind(api),
    payments: async.retryable(3, api.getPayments.bind(api))
}, function(err, results) {
    // do something with the results
});
مصدر:
retry.js , line 5
نرى:

async.retryable

(static) retryable(opts opt , task) â†' { AsyncFunction }

import retryable from 'async/retryable';

A close relative of retry . This method wraps a task and makes it retryable, rather than immediately calling it with retries.

المعلمات:

اسم اكتب افتراضي وصف
opts Object | number <optional> {times: 5, interval: 0}| 5

optional options, exactly the same as from retry

task AsyncFunction

the asynchronous function to wrap. This function will be passed any arguments passed to the returned wrapper. Invoked with (...args, callback).

عائدات:

The wrapped function, which when invoked, will retry on an error, based on the parameters specified in opts . This function will accept the same parameters as task .

اكتب
AsyncFunction

مثال

async.auto({
    dep1: async.retryable(3, getFromFlakyService),
    process: ["dep1", async.retryable(3, function (results, cb) {
        maybeProcessData(results.dep1, cb);
    })]
}, callback);
مصدر:
retryable.js , line 5
نرى:

retry

(static) seq(…functions) â†' {function}

import seq from 'async/seq';

Version of the compose function that is more natural to read. Each function consumes the return value of the previous function. It is the equivalent of compose with the arguments reversed.

Each function is executed with the this binding of the composed function.

المعلمات:

اسم اكتب وصف
functions AsyncFunction

the asynchronous functions to compose

عائدات:

a function that composes the functions in order

اكتب
function

مثال

// Requires lodash (or underscore), express3 and dresende's orm2.
// Part of an app, that fetches cats of the logged user.
// This example uses `seq` function to avoid overnesting and error
// handling clutter.
app.get('/cats', function(request, response) {
    var User = request.models.User;
    async.seq(
        _.bind(User.get, User),  // 'User.get' has signature (id, callback(err, data))
        function(user, fn) {
            user.getCats(fn);      // 'getCats' has signature (callback(err, data))
        }
    )(req.session.user_id, function (err, cats) {
        if (err) {
            console.error(err);
            response.json({ status: 'error', message: err.message });
        } else {
            response.json({ status: 'ok', message: 'Cats found', data: cats });
        }
    });
});
مصدر:
seq.js , line 7
نرى:

compose

(static) series(tasks, callback opt )

import series from 'async/series';

Run the functions in the tasks collection in series, each one running once the previous function has completed. If any functions in the series pass an error to its callback, no more functions are run, and callback is immediately called with the value of the error. Otherwise, callback receives an array of results when tasks have completed.

It is also possible to use an object instead of an array. Each property will be run as a function, and the results will be passed to the final callback as an object instead of an array. This can be a more readable way of handling results from async.series.

Note that while many implementations preserve the order of object properties, the ECMAScript Language Specification explicitly states that

The mechanics and order of enumerating the properties is not specified.

So if you rely on the order in which your series of functions are executed, and want this to work on all platforms, consider using an array.

المعلمات:

اسم اكتب وصف
tasks Array | Iterable | موضوع

A collection containing AsyncFunction to run in series. Each function can complete with any number of optional result values.

callback function <optional>

An optional callback to run once all the functions have completed. This function gets a results array (or object) containing all the result arguments passed to the task callbacks. Invoked with (err, result).

مثال

async.series([
    function(callback) {
        // do some stuff ...
        callback(null, 'one');
    },
    function(callback) {
        // do some more stuff ...
        callback(null, 'two');
    }
],
// optional callback
function(err, results) {
    // results is now equal to ['one', 'two']
});

async.series({
    one: function(callback) {
        setTimeout(function() {
            callback(null, 1);
        }, 200);
    },
    two: function(callback){
        setTimeout(function() {
            callback(null, 2);
        }, 100);
    }
}, function(err, results) {
    // results is now equal to: {one: 1, two: 2}
});
مصدر:
series.js , line 4

(static) times(n, iteratee, callback)

import times from 'async/times';

Calls the iteratee function n times, and accumulates results in the same manner you would use with map .

المعلمات:

اسم اكتب وصف
n number

The number of times to run the function.

iteratee AsyncFunction

The async function to call n times. Invoked with the iteration index and a callback: (n, next).

callback function

see map .

مثال

// Pretend this is some complicated async factory
var createUser = function(id, callback) {
    callback(null, {
        id: 'user' + id
    });
};

// generate 5 users
async.times(5, function(n, next) {
    createUser(n, function(err, user) {
        next(err, user);
    });
}, function(err, users) {
    // we should now have 5 users
});
مصدر:
times.js , line 4
نرى:

map

(static) timesLimit(count, limit, iteratee, callback)

import timesLimit from 'async/timesLimit';

The same as times but runs a maximum of limit async operations at a time.

المعلمات:

اسم اكتب وصف
count number

The number of times to run the function.

limit number

The maximum number of async operations at a time.

iteratee AsyncFunction

The async function to call n times. Invoked with the iteration index and a callback: (n, next).

callback function

see map .

مصدر:
timesLimit.js , line 5
نرى:

times

(static) timesSeries(n, iteratee, callback)

import timesSeries from 'async/timesSeries';

The same as times but runs only a single async operation at a time.

المعلمات:

اسم اكتب وصف
n number

The number of times to run the function.

iteratee AsyncFunction

The async function to call n times. Invoked with the iteration index and a callback: (n, next).

callback function

see map .

مصدر:
timesSeries.js , line 4
نرى:

times

(static) tryEach(tasks, callback opt )

import tryEach from 'async/tryEach';

It runs each task in series but stops whenever any of the functions were successful. If one of the tasks were successful, the callback will be passed the result of the successful task. If all tasks fail, the callback will be passed the error and result (if any) of the final attempt.

المعلمات:

اسم اكتب وصف
tasks Array | Iterable | موضوع

A collection containing functions to run, each function is passed a callback(err, result) it must call on completion with an error err (which can be null ) and an optional result value.

callback function <optional>

An optional callback which is called when one of the tasks has succeeded, or all have failed. It receives the err and result arguments of the last attempt at completing the task . Invoked with (err, results).

مثال

async.tryEach([
    function getDataFromFirstWebsite(callback) {
        // Try getting the data from the first website
        callback(err, data);
    },
    function getDataFromSecondWebsite(callback) {
        // First website failed,
        // Try getting the data from the backup website
        callback(err, data);
    }
],
// optional callback
function(err, results) {
    Now do something with the data.
});
مصدر:
tryEach.js , line 6

(static) until(test, iteratee, callback opt )

import until from 'async/until';

Repeatedly call iteratee until test returns true . Calls callback when stopped, or an error occurs. callback will be passed an error and any arguments passed to the final iteratee 's callback.

The inverse of whilst .

المعلمات:

اسم اكتب وصف
test function

synchronous truth test to perform before each execution of iteratee . Invoked with ().

iteratee AsyncFunction

An async function which is called each time test fails. Invoked with (callback).

callback function <optional>

A callback which is called after the test function has passed and repeated execution of iteratee has stopped. callback will be passed an error and any arguments passed to the final iteratee 's callback. Invoked with (err, [results]);

مصدر:
until.js , line 3
نرى:

whilst

(static) waterfall(tasks, callback opt )

import waterfall from 'async/waterfall';

Runs the tasks array of functions in series, each passing their results to the next in the array. However, if any of the tasks pass an error to their own callback, the next function is not executed, and the main callback is immediately called with the error.

المعلمات:

اسم اكتب وصف
tasks مجموعة مصفوفة

An array of AsyncFunction to run. Each function should complete with any number of result values. The result values will be passed as arguments, in order, to the next task.

callback function <optional>

An optional callback to run once all the functions have completed. This will be passed the results of the last task's callback. Invoked with (err, [results]).

عائدات:

غير محدد

مثال

async.waterfall([
    function(callback) {
        callback(null, 'one', 'two');
    },
    function(arg1, arg2, callback) {
        // arg1 now equals 'one' and arg2 now equals 'two'
        callback(null, 'three');
    },
    function(arg1, callback) {
        // arg1 now equals 'three'
        callback(null, 'done');
    }
], function (err, result) {
    // result now equals 'done'
});

// Or, with named functions:
async.waterfall([
    myFirstFunction,
    mySecondFunction,
    myLastFunction,
], function (err, result) {
    // result now equals 'done'
});
function myFirstFunction(callback) {
    callback(null, 'one', 'two');
}
function mySecondFunction(arg1, arg2, callback) {
    // arg1 now equals 'one' and arg2 now equals 'two'
    callback(null, 'three');
}
function myLastFunction(arg1, callback) {
    // arg1 now equals 'three'
    callback(null, 'done');
}
مصدر:
waterfall.js , line 9

(static) whilst(test, iteratee, callback opt )

import whilst from 'async/whilst';

Repeatedly call iteratee , while test returns true . Calls callback when stopped, or an error occurs.

المعلمات:

اسم اكتب وصف
test function

synchronous truth test to perform before each execution of iteratee . Invoked with ().

iteratee AsyncFunction

An async function which is called each time test passes. Invoked with (callback).

callback function <optional>

A callback which is called after the test function has failed and repeated execution of iteratee has stopped. callback will be passed an error and any arguments passed to the final iteratee 's callback. Invoked with (err, [results]);

عائدات:

غير محدد

مثال

var count = 0;
async.whilst(
    function() { return count < 5; },
    function(callback) {
        count++;
        setTimeout(function() {
            callback(null, count);
        }, 1000);
    },
    function (err, n) {
        // 5 seconds have passed, n = 5
    }
);
مصدر:
whilst.js , line 7

تعريفات النوع

CargoObject

import cargo from 'async/cargo';

A cargo of tasks for the worker function to complete. Cargo inherits all of the same methods and event callbacks as queue .

اكتب:

  • موضوع

الخصائص:

اسم اكتب وصف
length function

A function returning the number of items waiting to be processed. Invoke like cargo.length() .

payload number

An integer for determining how many tasks should be process per round. This property can be changed after a cargo is created to alter the payload on-the-fly.

push function

Adds task to the queue . The callback is called once the worker has finished processing the task. Instead of a single task, an array of tasks can be submitted. The respective callback is used for every task in the list. Invoke like cargo.push(task, [callback]) .

saturated function

A callback that is called when the queue.length() hits the concurrency and further tasks will be queued.

empty function

A callback that is called when the last item from the queue is given to a worker .

drain function

A callback that is called when the last item from the queue has returned from the worker .

idle function

a function returning false if there are items waiting or being processed, or true if not. Invoke like cargo.idle() .

pause function

a function that pauses the processing of tasks until resume() is called. Invoke like cargo.pause() .

resume function

a function that resumes the processing of queued tasks when the queue is paused. Invoke like cargo.resume() .

kill function

a function that removes the drain callback and empties remaining tasks from the queue forcing it to go idle. Invoke like cargo.kill() .

مصدر:
cargo.js , line 3

QueueObject

import queue from 'async/queue';

A queue of tasks for the worker function to complete.

اكتب:

  • موضوع

الخصائص:

اسم اكتب وصف
length function

a function returning the number of items waiting to be processed. Invoke with queue.length() .

started boolean

a boolean indicating whether or not any items have been pushed and processed by the queue.

running function

a function returning the number of items currently being processed. Invoke with queue.running() .

workersList function

a function returning the array of items currently being processed. Invoke with queue.workersList() .

idle function

a function returning false if there are items waiting or being processed, or true if not. Invoke with queue.idle() .

concurrency number

an integer for determining how many worker functions should be run in parallel. This property can be changed after a queue is created to alter the concurrency on-the-fly.

push function

add a new task to the queue . Calls callback once the worker has finished processing the task. Instead of a single task, a tasks array can be submitted. The respective callback is used for every task in the list. Invoke with queue.push(task, [callback]) ,

unshift function

add a new task to the front of the queue . Invoke with queue.unshift(task, [callback]) .

remove function

remove items from the queue that match a test function. The test function will be passed an object with a data property, and a priority property, if this is a priorityQueue object. Invoked with queue.remove(testFn) , where testFn is of the form function ({data, priority}) {} and returns a Boolean.

saturated function

a callback that is called when the number of running workers hits the concurrency limit, and further tasks will be queued.

unsaturated function

a callback that is called when the number of running workers is less than the concurrency & buffer limits, and further tasks will not be queued.

buffer number

A minimum threshold buffer in order to say that the queue is unsaturated .

empty function

a callback that is called when the last item from the queue is given to a worker .

drain function

a callback that is called when the last item from the queue has returned from the worker .

error function

a callback that is called when a task errors. Has the signature function(error, task) .

paused boolean

a boolean for determining whether the queue is in a paused state.

pause function

a function that pauses the processing of tasks until resume() is called. Invoke with queue.pause() .

resume function

a function that resumes the processing of queued tasks when the queue is paused. Invoke with queue.resume() .

kill function

a function that removes the drain callback and empties remaining tasks from the queue forcing it to go idle. No more tasks should be pushed to the queue after calling this function. Invoke with queue.kill() .

مصدر:
queue.js , line 4

Utils

A collection of async utility functions.

مصدر:
index.js , line 61

أساليب

(static) apply(fn) â†' {function}

import apply from 'async/apply';

Creates a continuation function with some arguments already applied.

Useful as a shorthand when combined with other control flow functions. Any arguments passed to the returned function are added to the arguments originally passed to apply.

المعلمات:

اسم اكتب وصف
fn function

The function you want to eventually apply all arguments to. Invokes with (arguments...).

arguments... *

Any number of arguments to automatically apply when the continuation is called.

عائدات:

the partially-applied function

اكتب
function

مثال

// using apply
async.parallel([
    async.apply(fs.writeFile, 'testfile1', 'test1'),
    async.apply(fs.writeFile, 'testfile2', 'test2')
]);


// the same process without using apply
async.parallel([
    function(callback) {
        fs.writeFile('testfile1', 'test1', callback);
    },
    function(callback) {
        fs.writeFile('testfile2', 'test2', callback);
    }
]);

// It's possible to pass any number of additional arguments when calling the
// continuation:

node> var fn = async.apply(sys.puts, 'one');
node> fn('two', 'three');
one
two
three
مصدر:
apply.js , line 3

(static) asyncify(func) â†' { AsyncFunction }

import asyncify from 'async/asyncify';

Take a sync function and make it async, passing its return value to a callback. This is useful for plugging sync functions into a waterfall, series, or other async functions. Any arguments passed to the generated function will be passed to the wrapped function (except for the final callback argument). Errors thrown will be passed to the callback.

If the function passed to asyncify returns a Promise, that promises's resolved/rejected state will be used to call the callback, rather than simply the synchronous return value.

This also means you can asyncify ES2017 async functions.

Alias:
wrapSync

المعلمات:

اسم اكتب وصف
func function

The synchronous function, or Promise-returning function to convert to an AsyncFunction .

عائدات:

An asynchronous wrapper of the func . To be invoked with (args..., callback) .

اكتب
AsyncFunction

مثال

// passing a regular synchronous function
async.waterfall([
    async.apply(fs.readFile, filename, "utf8"),
    async.asyncify(JSON.parse),
    function (data, next) {
        // data is the result of parsing the text.
        // If there was a parsing error, it would have been caught.
    }
], callback);

// passing a function returning a promise
async.waterfall([
    async.apply(fs.readFile, filename, "utf8"),
    async.asyncify(function (contents) {
        return db.model.create(contents);
    }),
    function (model, next) {
        // `model` is the instantiated model object.
        // If there was an error, this function would be skipped.
    }
], callback);

// es2017 example, though `asyncify` is not needed if your JS environment
// supports async functions out of the box
var q = async.queue(async.asyncify(async function(file) {
    var intermediateStep = await processFile(file);
    return await somePromise(intermediateStep)
}));

q.push(files);
مصدر:
asyncify.js , line 5

(static) constant() â†' { AsyncFunction }

import constant from 'async/constant';

Returns a function that when called, calls-back with the values provided. Useful as the first function in a waterfall , or for plugging values in to async.auto .

المعلمات:

اسم اكتب وصف
arguments... *

Any number of arguments to automatically invoke callback with.

عائدات:

Returns a function that when invoked, automatically invokes the callback with the previous given arguments.

اكتب
AsyncFunction

مثال

async.waterfall([
    async.constant(42),
    function (value, next) {
        // value === 42
    },
    //...
], callback);

async.waterfall([
    async.constant(filename, "utf8"),
    fs.readFile,
    function (fileData, next) {
        //...
    }
    //...
], callback);

async.auto({
    hostname: async.constant("https://server.net/"),
    port: findFreePort,
    launchServer: ["hostname", "port", function (options, cb) {
        startServer(options, cb);
    }],
    //...
}, callback);
مصدر:
constant.js , line 3

(static) dir(function)

import dir from 'async/dir';

Logs the result of an AsyncFunction to the console using console.dir to display the properties of the resulting object. Only works in Node.js or in browsers that support console.dir and console.error (such as FF and Chrome). If multiple arguments are returned from the async function, console.dir is called on each argument in order.

المعلمات:

اسم اكتب وصف
function AsyncFunction

The function you want to eventually apply all arguments to.

arguments... *

Any number of arguments to apply to the function.

مثال

// in a module
var hello = function(name, callback) {
    setTimeout(function() {
        callback(null, {hello: name});
    }, 1000);
};

// in the node repl
node> async.dir(hello, 'world');
{hello: 'world'}
مصدر:
dir.js , line 3

(static) ensureAsync(fn) â†' { AsyncFunction }

import ensureAsync from 'async/ensureAsync';

Wrap an async function and ensure it calls its callback on a later tick of the event loop. If the function already calls its callback on a next tick, no extra deferral is added. This is useful for preventing stack overflows ( RangeError: Maximum call stack size exceeded ) and generally keeping Zalgo contained. ES2017 async functions are returned as-is -- they are immune to Zalgo's corrupting influences, as they always resolve on a later tick.

المعلمات:

اسم اكتب وصف
fn AsyncFunction

an async function, one that expects a node-style callback as its last argument.

عائدات:

Returns a wrapped function with the exact same call signature as the function passed in.

اكتب
AsyncFunction

مثال

function sometimesAsync(arg, callback) {
    if (cache[arg]) {
        return callback(null, cache[arg]); // this would be synchronous!!
    } else {
        doSomeIO(arg, callback); // this IO would be asynchronous
    }
}

// this has a risk of stack overflows if many results are cached in a row
async.mapSeries(args, sometimesAsync, done);

// this will defer sometimesAsync's callback if necessary,
// preventing stack overflows
async.mapSeries(args, async.ensureAsync(sometimesAsync), done);
مصدر:
ensureAsync.js , line 5

(static) log(function)

import log from 'async/log';

Logs the result of an async function to the console . Only works in Node.js or in browsers that support console.log and console.error (such as FF and Chrome). If multiple arguments are returned from the async function, console.log is called on each argument in order.

المعلمات:

اسم اكتب وصف
function AsyncFunction

The function you want to eventually apply all arguments to.

arguments... *

Any number of arguments to apply to the function.

مثال

// in a module
var hello = function(name, callback) {
    setTimeout(function() {
        callback(null, 'hello ' + name);
    }, 1000);
};

// in the node repl
node> async.log(hello, 'world');
'hello world'
مصدر:
log.js , line 3

(static) memoize(fn, hasher) â†' { AsyncFunction }

import memoize from 'async/memoize';

Caches the results of an async function. When creating a hash to store function results against, the callback is omitted from the hash and an optional hash function can be used.

If no hash function is specified, the first argument is used as a hash key, which may work reasonably if it is a string or a data type that converts to a distinct string. Note that objects and arrays will not behave reasonably. Neither will cases where the other arguments are significant. In such cases, specify your own hash function.

The cache of results is exposed as the memo property of the function returned by memoize .

المعلمات:

اسم اكتب وصف
fn AsyncFunction

The async function to proxy and cache results from.

hasher function

An optional function for generating a custom hash for storing results. It has all the arguments applied to it apart from the callback, and must be synchronous.

عائدات:

a memoized version of fn

اكتب
AsyncFunction

مثال

var slow_fn = function(name, callback) {
    // do something
    callback(null, result);
};
var fn = async.memoize(slow_fn);

// fn can now be used as if it were slow_fn
fn('some name', function() {
    // callback
});
مصدر:
memoize.js , line 12

(static) nextTick(callback)

import nextTick from 'async/nextTick';

Calls callback on a later loop around the event loop. In Node.js this just calls process.nextTicl . In the browser it will use setImmediate if available, otherwise setTimeout(callback, 0) , which means other higher priority events may precede the execution of callback .

This is used internally for browser-compatibility purposes.

المعلمات:

اسم اكتب وصف
callback function

The function to call on a later loop around the event loop. Invoked with (args...).

args... *

any number of additional arguments to pass to the callback on the next tick.

مثال

var call_order = [];
async.nextTick(function() {
    call_order.push('two');
    // call_order now equals ['one','two']
});
call_order.push('one');

async.setImmediate(function (a, b, c) {
    // a, b, and c equal 1, 2, and 3
}, 1, 2, 3);
مصدر:
nextTick.js , line 5
نرى:

async.setImmediate

(static) reflect(fn) â†' {function}

import reflect from 'async/reflect';

Wraps the async function in another function that always completes with a result object, even when it errors.

The result object has either the property error or value .

المعلمات:

اسم اكتب وصف
fn AsyncFunction

The async function you want to wrap

عائدات:

  • A function that always passes null to it's callback as the error. The second argument to the callback will be an object with either an error or a value property.
اكتب
function

مثال

async.parallel([
    async.reflect(function(callback) {
        // do some stuff ...
        callback(null, 'one');
    }),
    async.reflect(function(callback) {
        // do some more stuff but error ...
        callback('bad stuff happened');
    }),
    async.reflect(function(callback) {
        // do some more stuff ...
        callback(null, 'two');
    })
],
// optional callback
function(err, results) {
    // values
    // results[0].value = 'one'
    // results[1].error = 'bad stuff happened'
    // results[2].value = 'two'
});
مصدر:
reflect.js , line 5

(static) reflectAll(tasks) â†' {Array}

import reflectAll from 'async/reflectAll';

A helper function that wraps an array or an object of functions with reflect .

المعلمات:

اسم اكتب وصف
tasks Array | Object | Iterable

The collection of AsyncFunction to wrap in async.reflect .

عائدات:

Returns an array of async functions, each wrapped in async.reflect

اكتب
مجموعة مصفوفة

مثال

let tasks = [
    function(callback) {
        setTimeout(function() {
            callback(null, 'one');
        }, 200);
    },
    function(callback) {
        // do some more stuff but error ...
        callback(new Error('bad stuff happened'));
    },
    function(callback) {
        setTimeout(function() {
            callback(null, 'two');
        }, 100);
    }
];

async.parallel(async.reflectAll(tasks),
// optional callback
function(err, results) {
    // values
    // results[0].value = 'one'
    // results[1].error = Error('bad stuff happened')
    // results[2].value = 'two'
});

// an example using an object instead of an array
let tasks = {
    one: function(callback) {
        setTimeout(function() {
            callback(null, 'one');
        }, 200);
    },
    two: function(callback) {
        callback('two');
    },
    three: function(callback) {
        setTimeout(function() {
            callback(null, 'three');
        }, 100);
    }
};

async.parallel(async.reflectAll(tasks),
// optional callback
function(err, results) {
    // values
    // results.one.value = 'one'
    // results.two.error = 'two'
    // results.three.value = 'three'
});
مصدر:
reflectAll.js , line 6
نرى:

reflect

(static) setImmediate(callback)

import setImmediate from 'async/setImmediate';

Calls callback on a later loop around the event loop. In Node.js this just calls setImmediate . In the browser it will use setImmediate if available, otherwise setTimeout(callback, 0) , which means other higher priority events may precede the execution of callback .

This is used internally for browser-compatibility purposes.

المعلمات:

اسم اكتب وصف
callback function

The function to call on a later loop around the event loop. Invoked with (args...).

args... *

any number of additional arguments to pass to the callback on the next tick.

مثال

var call_order = [];
async.nextTick(function() {
    call_order.push('two');
    // call_order now equals ['one','two']
});
call_order.push('one');

async.setImmediate(function (a, b, c) {
    // a, b, and c equal 1, 2, and 3
}, 1, 2, 3);
مصدر:
setImmediate.js , line 3
نرى:

async.nextTick

(static) timeout(asyncFn, milliseconds, info opt ) â†' { AsyncFunction }

import timeout from 'async/timeout';

Sets a time limit on an asynchronous function. If the function does not call its callback within the specified milliseconds, it will be called with a timeout error. The code property for the error object will be 'ETIMEDOUT' .

المعلمات:

اسم اكتب وصف
asyncFn AsyncFunction

The async function to limit in time.

milliseconds number

The specified time limit.

info * <optional>

Any variable you want attached ( string , object , etc) to timeout Error for more information..

عائدات:

Returns a wrapped function that can be used with any of the control flow functions. Invoke this function with the same parameters as you would asyncFunc .

اكتب
AsyncFunction

مثال

function myFunction(foo, callback) {
    doAsyncTask(foo, function(err, data) {
        // handle errors
        if (err) return callback(err);

        // do some stuff ...

        // return processed data
        return callback(null, data);
    });
}

var wrapped = async.timeout(myFunction, 1000);

// call `wrapped` as you would `myFunction`
wrapped({ bar: 'bar' }, function(err, data) {
    // if `myFunction` takes < 1000 ms to execute, `err`
    // and `data` will have their expected values

    // else `err` will be an Error with the code 'ETIMEDOUT'
});
مصدر:
timeout.js , line 4

(static) unmemoize(fn) â†' { AsyncFunction }

import unmemoize from 'async/unmemoize';

Undoes a memoize d function, reverting it to the original, unmemoized form. Handy for testing.

المعلمات:

اسم اكتب وصف
fn AsyncFunction

the memoized function

عائدات:

a function that calls the original unmemoized function

اكتب
AsyncFunction
مصدر:
unmemoize.js , line 1
نرى:

memoize

原文