This is the constructor. Use it to new up any parallel jobs. The constructor takes an array of data you want to operate on. This data will be held in memory until you finish your job, and can be accessed via the .data attribute of your job. The object returned by the Parallel constructor is meant to be chained, so you can produce a chain of operations on the provided data.
This is the data you wish to operate on. Will often be an array, but the only restrictions are that your values are serializable as JSON.
Some options for your job.
Data
Map will apply the supplied function to every element in the wrapped data. Parallel will spawn one worker for each array element in the data, or the supplied maxWorkers argument. The values returned will be stored for further processing.
A function to apply. Receives the wrapped data as an argument. The value returned will be assigned to the wrapped data.
Parallel instance.
Reduce applies an operation to every member of the wrapped data, and returns a scalar value produced by the operation. Use it for combining the results of a map operation, by summing numbers for example. This takes a reducing function, which gets an argument, data, an array of the stored value, and the current element.
A function to apply. Receives the stored value and current element as argument. The value returned will be stored as the current value for the next iteration. Finally, the current value will be assigned to current data.
Parallel instance.
If you have state that you want to share between your main thread and worker threads, this is how. Require takes either a string or a function. A string should point to a file name. NOte that in order to use require with a file name as an argument, you have to provide the evalPath property in the options object.
Parallel instance.
This function will spawn a new process on a worker thread. Pass it the function you want to call. Your function will receive one argument, which is the current data. The value returned from your spawned function will update the current data.
A function to execute on a worker thread. Receives the wrapped data as an argument. The value returned will be assigned to the wrapped data.
Parallel instance.
The functions given to then are called after the last requested operation has finished. success receives the resulting data object, while fail will receive an error object.
A function that gets called upon successful completion. Receives the wrapped data as an argument.
A function that gets called if the job fails. The function is passed an error object.
Parallel instance.