ExecutionStrategy overview

Added in v2.0.0

Table of contents

• constructors
  • parallel
  • parallelN
  • sequential
• folding
  • match
• models
  • ExecutionStrategy (type alias)
  • Parallel (interface)
  • ParallelN (interface)
  • Sequential (interface)
• refinements
  • isParallel
  • isParallelN
  • isSequential

constructors

parallel

Execute effects in parallel.

Signature

export declare const parallel: ExecutionStrategy

Added in v2.0.0

parallelN

Execute effects in parallel, up to the specified number of concurrent fibers.

Signature

export declare const parallelN: (parallelism: number) => ExecutionStrategy

Added in v2.0.0

sequential

Execute effects sequentially.

Signature

export declare const sequential: ExecutionStrategy

Added in v2.0.0

folding

match

Folds over the specified ExecutionStrategy using the provided case functions.

Signature

export declare const match: {
  <A>(options: {
    readonly onSequential: LazyArg<A>
    readonly onParallel: LazyArg<A>
    readonly onParallelN: (n: number) => A
  }): (self: ExecutionStrategy) => A
  <A>(
    self: ExecutionStrategy,
    options: {
      readonly onSequential: LazyArg<A>
      readonly onParallel: LazyArg<A>
      readonly onParallelN: (n: number) => A
    }
  ): A
}

Added in v2.0.0

models

ExecutionStrategy (type alias)

Describes a strategy for evaluating multiple effects, potentially in parallel.

There are 3 possible execution strategies: Sequential, Parallel, ParallelN.

Signature

export type ExecutionStrategy = Sequential | Parallel | ParallelN

Added in v2.0.0

Parallel (interface)

Execute effects in parallel.

Signature

export interface Parallel {
  readonly _tag: "Parallel"
}

Added in v2.0.0

ParallelN (interface)

Execute effects in parallel, up to the specified number of concurrent fibers.

Signature

export interface ParallelN {
  readonly _tag: "ParallelN"
  readonly parallelism: number
}

Added in v2.0.0

Sequential (interface)

Execute effects sequentially.

Signature

export interface Sequential {
  readonly _tag: "Sequential"
}

Added in v2.0.0

refinements

isParallel

Returns true if the specified ExecutionStrategy is an instance of Sequential, false otherwise.

Signature

export declare const isParallel: (self: ExecutionStrategy) => self is Parallel

Added in v2.0.0

isParallelN

Returns true if the specified ExecutionStrategy is an instance of Sequential, false otherwise.

Signature

export declare const isParallelN: (self: ExecutionStrategy) => self is ParallelN

Added in v2.0.0

isSequential

Returns true if the specified ExecutionStrategy is an instance of Sequential, false otherwise.

Signature

export declare const isSequential: (self: ExecutionStrategy) => self is Sequential

Added in v2.0.0