README.md
2.83 KB
#items
Bare minimum async methods adapted specifically for the very limited hapi core use cases. Use async for all your application needs.
Lead Maintainer - Raquel Vélez
Items.serial(items, method, callback)
Runs method
against each value in the items
array in series. callback
is executed when all of the tasks are complete. Calling back with an error will short-circuit the remaining tasks.
-
items
an array of items to pass tomethod
. -
method
a function with the signaturefunction (item, next, i)
.-
item
- is the currently processing item in theitems
array. -
next
- callback function to indicate the end of processing foritem
. Callingnext
with a truthy parameter indicates an error and endsItems.serial
. -
i
- The current item's index in theitems
array.
-
-
callback
- a function with the signaturefunction (err)
.-
err
- indicates any errors during processing.
-
Items.parallel(items, method, callback)
Runs method
against each value in the items
array in parallel. callback
is executed when all of the tasks are complete. Calling back with an error will short-circuit the remaining tasks.
-
items
an array of items to pass tomethod
. -
method
a function with the signaturefunction (item, next, i)
.-
item
- is the currently processing item in theitems
array. -
next
- callback function to indicate the end of processing foritem
. Callingnext
with a truthy parameter indicates an error and endsItems.parallel
. -
i
- The current item's index in theitems
array.
-
-
callback
- a function with the signaturefunction (err)
.-
err
- indicates any errors during processing.
-
Items.parallel.execute(tasks, callback)
Runs all of the functions in tasks
in parallel and stores the results in a collector object passed into callback
. If any of the tasks callback with an error, the collector object is null
.
-
tasks
- on object containing functions to execute in parallel. Thekey
of the function is thekey
in the result of collector object. The task should have the signaturefunction (next)
-
next(err, result)
- callback function to indicate the end of processing for the current task.-
err
- indicates any errors during processing. -
result
- result of this function. This value will be set on the collector object in the final callback.
-
-
-
callback(err, result)
-
err
- any errors reported by any of thetasks
. -
result
- an object containing the result of running all of thetasks
.result
will benull
if any of the tasks callback with an error. Theresult.key
will be the correspondingkey
of thetasks
object.
-