worker-farm

  • Version 1.7.0
  • Published
  • 49.9 kB
  • 1 dependency
  • MIT license

Install

npm i worker-farm
yarn add worker-farm
pnpm add worker-farm

Overview

Distribute processing tasks to child processes with an über-simple API and baked-in durability & custom concurrency options.

Index

Functions

function end

end: (workers: Workers, callback?: Function) => void;

    function Farm

    Farm: typeof Farm;

      Interfaces

      interface FarmOptions

      interface FarmOptions {}

        property autoStart

        autoStart?: boolean;

          property maxCallsPerWorker

          maxCallsPerWorker?: number;

            property maxCallTime

            maxCallTime?: number;

              property maxConcurrentCalls

              maxConcurrentCalls?: number;

                property maxConcurrentCallsPerWorker

                maxConcurrentCallsPerWorker?: number;

                  property maxConcurrentWorkers

                  maxConcurrentWorkers?: number;

                    property maxRetries

                    maxRetries?: number;

                      property workerOptions

                      workerOptions?: ForkOptions;

                        interface Workers

                        interface Workers {}

                          call signature

                          (callback: WorkerCallback): void;

                            call signature

                            (arg1: any, callback: WorkerCallback): void;

                              call signature

                              (arg1: any, arg2: any, callback: WorkerCallback): void;

                                call signature

                                (arg1: any, arg2: any, arg3: any, callback: WorkerCallback): void;

                                  call signature

                                  (arg1: any, arg2: any, arg3: any, arg4: any, callback: WorkerCallback): void;

                                    index signature

                                    [x: string]: Workers;

                                      Type Aliases

                                      type WorkerCallback

                                      type WorkerCallback =
                                      | WorkerCallback0
                                      | WorkerCallback1
                                      | WorkerCallback2
                                      | WorkerCallback3
                                      | WorkerCallback4;

                                        Package Files (1)

                                        Dependencies (1)

                                        Dev Dependencies (1)

                                        Peer Dependencies (0)

                                        No peer dependencies.

                                        Badge

                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/worker-farm.

                                        • Markdown
                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/worker-farm)
                                        • HTML
                                          <a href="https://www.jsdocs.io/package/worker-farm"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>