Skip to content

Take

The Take module provides the stored representation of one pull result from a stream-like producer. A Take<A, E, Done> is either a non-empty batch of emitted values, a failed Exit, or a successful Exit carrying the completion value.

2 exports Added in v2.0.0 Source

Converting

toPull

Added in v4.0.0 Source

Converts a Take into a Pull, succeeding with value batches, failing with failure exits, and translating successful exits into pull completion.

When to use

Use to interpret a stored or transferred Take as a Pull step while preserving emitted batches, ordinary failures, and completion values.

Signature

declare function toPull<A, E, Done>(take: Take<A, E, Done>): Pull<readonly [A, A], E, Done>;

Models

Take type

Added in v2.0.0 Source

Represents one pull result: either a non-empty batch of values, a failure Exit, or a successful Exit that signals completion with a Done value.

When to use

Use to store, transfer, or interpret pull results later while preserving emitted values, failures, and normal completion.

See

  • toPull for interpreting a Take as a Pull step

Signature

type Take<A, E = never, Done = void> = NonEmptyReadonlyArray<A> | Exit.Exit<Done, E>;