Class Parallel

Hierarchy

Parallel

Index

Constructors

constructor

new Parallel(options?: ParallelOptions): Parallel
Parameters
- Optional options: ParallelOptions
Returns Parallel
- Defined in Parallel.ts:179

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

Returns boolean
- Defined in Parallel.ts:192

Methods

`Protected` _getWorkerSource

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

`Protected` _spawnWorker

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

map

map<T, U>(data: T[], task: ((data: T) => U), env?: unknown): ArrayPromise
Waits for all tasks to resolve and returns a promise with the results.

Returns
Type Parameters
- T
- U
Parameters
- data: T[]
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
- Optional env: unknown
Returns ArrayPromise
- Defined in Parallel.ts:446

pipe

pipe<T, U>(data: T[], task: ((data: T) => U), env?: unknown): PromiseCollection
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.

Returns
Type Parameters
- T
- U
Parameters
- data: T[]
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
- Optional env: unknown
Returns PromiseCollection
- Defined in Parallel.ts:356

require

require(...required: RequireType[]): Parallel
Adds prerequisites (required) for the workers.

Returns
Parameters
- Rest ...required: RequireType[]
  
  URLs (strings) or Functions (serialized).
Returns Parallel
- Defined in Parallel.ts:264

requireThese

requireThese(required: RequireType[]): Parallel
Adds prerequisites (required) for the workers.

Returns
Parameters
- required: RequireType[]
  
  URLs (strings) or Functions (serialized).
Returns Parallel
- Defined in Parallel.ts:274

startLocal

startLocal<T, U>(data: T, task: ((data: T) => U)): TSDNPromise
Runs the task within the local thread/process. Is good for use with testing.

Returns
Type Parameters
- T
- U
Parameters
- data: T
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
Returns TSDNPromise
- Defined in Parallel.ts:333

startNew

startNew<T, U>(data: T, task: ((data: T) => U), env?: unknown): TSDNPromise
Schedules the task to be run in the worker pool.

Returns
Type Parameters
- T
- U
Parameters
- data: T
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
- Optional env: unknown
Returns TSDNPromise
- Defined in Parallel.ts:304

`Static` map

map<T, U>(data: T[], task: ((data: T) => U), env?: unknown): ArrayPromise
Asynchronously resolves an array of results processed through the paralleled task function.

Returns
Type Parameters
- T
- U
Parameters
- data: T[]
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
- Optional env: unknown
Returns ArrayPromise
- Defined in Parallel.ts:254

`Static` maxConcurrency

maxConcurrency(max: number): Parallel
Creates a Parallel with the specified max concurrency.

Returns
Parameters
- max: number
Returns Parallel
- Defined in Parallel.ts:200

`Static` options

options(options?: ParallelOptions): Parallel
Returns a Parallel with the specified options.

Returns
Parameters
- Optional options: ParallelOptions
Returns Parallel
- Defined in Parallel.ts:210

`Static` require

require(...required: RequireType[]): Parallel
Returns a parallel with the specified prerequisite requirements.

Returns
Parameters
- Rest ...required: RequireType[]
Returns Parallel
- Defined in Parallel.ts:220

`Static` requireThese

requireThese(required: RequireType[]): Parallel
Returns a parallel with the specified prerequisite requirements.

Returns
Parameters
- required: RequireType[]
Returns Parallel
- Defined in Parallel.ts:230

`Static` startNew

startNew<T, U>(data: T, task: ((data: T) => U), env?: unknown): PromiseBase
Starts a new default option (no requirements) Parallel with the specified data and task and resolves a promise when complete.

Returns
Type Parameters
- T
- U
Parameters
- data: T
- task: ((data: T) => U)
 - - (data: T): U
 - Parameters
 
 data: T
 
 Returns U
- Optional env: unknown
Returns PromiseBase
- Defined in Parallel.ts:242

Class Parallel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: ParallelOptions

Returns Parallel

Properties

Protected Readonly _requiredFunctions

Protected Readonly _requiredScripts

Readonly options

Accessors

Static isSupported

Returns

Returns boolean

Methods

Protected _getWorkerSource

Parameters

task: string | Function

Optional env: unknown

Returns string

Protected _spawnWorker

Parameters

task: string | Function

Optional env: unknown

Returns undefined | WorkerLike

map

Returns

Type Parameters

T

U

Parameters

data: T[]

task: ((data: T) => U)

Parameters

data: T

Returns U

Optional env: unknown

Returns ArrayPromise<U>

pipe

Returns

Type Parameters

T

U

Parameters

data: T[]

task: ((data: T) => U)

Parameters

data: T

Returns U

Optional env: unknown

Returns PromiseCollection<U>

require

Returns

Parameters

Rest ...required: RequireType[]

Returns Parallel

requireThese

Returns

Parameters

required: RequireType[]

Returns Parallel

startLocal

Returns

Type Parameters

T

U

Parameters

data: T

task: ((data: T) => U)

Parameters

data: T

Returns U

Returns TSDNPromise<U>

startNew

`Optional` options: ParallelOptions

`Protected` `Readonly` _requiredFunctions

`Protected` `Readonly` _requiredScripts

`Readonly` options

`Static` isSupported

`Protected` _getWorkerSource

`Optional` env: unknown

`Protected` _spawnWorker

`Optional` env: unknown

`Optional` env: unknown

`Optional` env: unknown

`Rest` ...required: RequireType[]

`Optional` env: unknown

`Static` map

`Optional` env: unknown

`Static` maxConcurrency

`Static` options

`Optional` options: ParallelOptions

`Static` require

`Rest` ...required: RequireType[]

`Static` requireThese

`Static` startNew

`Optional` env: unknown