Class Parallel

Index

Constructors

Properties

_requiredFunctions _requiredScripts options

Accessors

Methods

_getWorkerSource _spawnWorker map pipe require requireThese startLocal startNew map maxConcurrency options require requireThese startNew

Constructors

constructor

new Parallel(options?: ParallelOptions): Parallel
Parameters
- Optionaloptions: ParallelOptions
Returns Parallel
- Defined in Parallel.ts:159

Properties

`Protected` `Readonly`_requiredFunctions

_requiredFunctions: { fn: Function; name?: string }[]

`Protected` `Readonly`_requiredScripts

_requiredScripts: string[]

`Readonly`options

options: ParallelOptions

Accessors

`Static`isSupported

get isSupported(): boolean
Returns true if paralleling is supported.

Returns boolean
- Defined in Parallel.ts:171

Methods

`Protected`_getWorkerSource

_getWorkerSource(task: string | Function, env?: unknown): string
Parameters
- task: string | Function
- Optionalenv: unknown
Returns string
- Defined in Parallel.ts:469

`Protected`_spawnWorker

_spawnWorker(task: string | Function, env?: unknown): undefined | WorkerLike
Parameters
- task: string | Function
- Optionalenv: unknown
Returns undefined | WorkerLike
- Defined in Parallel.ts:496

map

map<T, U>(data: T[], task: (data: T) => U, env?: unknown): ArrayPromise<U>
Waits for all tasks to resolve and returns a promise with the results.
Type Parameters
- T
- U
Parameters
- data: T[]
- task: (data: T) => U
- Optionalenv: unknown
Returns ArrayPromise<U>
- Defined in Parallel.ts:399

pipe

pipe<T, U>(data: T[], task: (data: T) => U, env?: unknown): PromiseCollection<U>
Returns an array of promises that each resolve after their task completes. Provides a potential performance benefit by not waiting for all promises to resolve before proceeding to next step.
Type Parameters
- T
- U
Parameters
- data: T[]
- task: (data: T) => U
- Optionalenv: unknown
Returns PromiseCollection<U>
- Defined in Parallel.ts:319

require

require(...required: RequireType[]): this
Adds prerequisites (required) for the workers.
Parameters
- ...required: RequireType[]
  URLs (strings) or Functions (serialized).
Returns this
- Defined in Parallel.ts:236

requireThese

requireThese(required: RequireType[]): this
Adds prerequisites (required) for the workers.
Parameters
- required: RequireType[]
  URLs (strings) or Functions (serialized).
Returns this
- Defined in Parallel.ts:245

startLocal

startLocal<T, U>(data: T, task: (data: T) => U): TSDNPromise<U>
Runs the task within the local thread/process. Is good for use with testing.
Type Parameters
- T
- U
Parameters
- data: T
- task: (data: T) => U
Returns TSDNPromise<U>
- Defined in Parallel.ts:299

startNew

startNew<T, U>(data: T, task: (data: T) => U, env?: unknown): TSDNPromise<U>
Schedules the task to be run in the worker pool.
Type Parameters
- T
- U
Parameters
- data: T
- task: (data: T) => U
- Optionalenv: unknown
Returns TSDNPromise<U>
- Defined in Parallel.ts:272

`Static`map

map<T, U>(data: T[], task: (data: T) => U, env?: unknown): ArrayPromise<U>
Asynchronously resolves an array of results processed through the paralleled task function.
Type Parameters
- T
- U
Parameters
- data: T[]
- task: (data: T) => U
- Optionalenv: unknown
Returns ArrayPromise<U>
- Defined in Parallel.ts:227

`Static`maxConcurrency

maxConcurrency(max: number): Parallel
Creates a Parallel with the specified max concurrency.
Parameters
- max: number
Returns Parallel
- Defined in Parallel.ts:178

`Static`options

options(options?: ParallelOptions): Parallel
Returns a Parallel with the specified options.
Parameters
- Optionaloptions: ParallelOptions
Returns Parallel
- Defined in Parallel.ts:187

`Static`require

require(...required: RequireType[]): Parallel
Returns a parallel with the specified prerequisite requirements.
Parameters
- ...required: RequireType[]
Returns Parallel
- Defined in Parallel.ts:196

`Static`requireThese

requireThese(required: RequireType[]): Parallel
Returns a parallel with the specified prerequisite requirements.
Parameters
- required: RequireType[]
Returns Parallel
- Defined in Parallel.ts:205

`Static`startNew

startNew<T, U>(data: T, task: (data: T) => U, env?: unknown): PromiseBase<U>
Starts a new default option (no requirements) Parallel with the specified data and task and resolves a promise when complete.
Type Parameters
- T
- U
Parameters
- data: T
- task: (data: T) => U
- Optionalenv: unknown
Returns PromiseBase<U>
- Defined in Parallel.ts:216