veffect
Version:
powerful TypeScript validation library built on the robust foundation of Effect combining exceptional type safety, high performance, and developer experience. Taking inspiration from Effect's functional principles, VEffect delivers a balanced approach tha
1,742 lines • 71.7 kB
JavaScript
import * as _groupBy from "./internal/groupBy.js";
import * as internal from "./internal/stream.js";
/**
* @since 2.0.0
* @category symbols
*/
export const StreamTypeId = internal.StreamTypeId;
/**
* The default chunk size used by the various combinators and constructors of
* `Stream`.
*
* @since 2.0.0
* @category constants
*/
export const DefaultChunkSize = internal.DefaultChunkSize;
/**
* Collects each underlying Chunk of the stream into a new chunk, and emits it
* on each pull.
*
* @since 2.0.0
* @category utils
*/
export const accumulate = internal.accumulate;
/**
* Re-chunks the elements of the stream by accumulating each underlying chunk.
*
* @since 2.0.0
* @category utils
*/
export const accumulateChunks = internal.accumulateChunks;
/**
* Creates a stream from a single value that will get cleaned up after the
* stream is consumed.
*
* @since 2.0.0
* @category constructors
*/
export const acquireRelease = internal.acquireRelease;
/**
* Aggregates elements of this stream using the provided sink for as long as
* the downstream operators on the stream are busy.
*
* This operator divides the stream into two asynchronous "islands". Operators
* upstream of this operator run on one fiber, while downstream operators run
* on another. Whenever the downstream fiber is busy processing elements, the
* upstream fiber will feed elements into the sink until it signals
* completion.
*
* Any sink can be used here, but see `Sink.foldWeightedEffect` and
* `Sink.foldUntilEffect` for sinks that cover the common usecases.
*
* @since 2.0.0
* @category utils
*/
export const aggregate = internal.aggregate;
/**
* Like `aggregateWithinEither`, but only returns the `Right` results.
*
* @param sink A `Sink` used to perform the aggregation.
* @param schedule A `Schedule` used to signal when to stop the aggregation.
* @since 2.0.0
* @category utils
*/
export const aggregateWithin = internal.aggregateWithin;
/**
* Aggregates elements using the provided sink until it completes, or until
* the delay signalled by the schedule has passed.
*
* This operator divides the stream into two asynchronous islands. Operators
* upstream of this operator run on one fiber, while downstream operators run
* on another. Elements will be aggregated by the sink until the downstream
* fiber pulls the aggregated value, or until the schedule's delay has passed.
*
* Aggregated elements will be fed into the schedule to determine the delays
* between pulls.
*
* @param sink A `Sink` used to perform the aggregation.
* @param schedule A `Schedule` used to signal when to stop the aggregation.
* @since 2.0.0
* @category utils
*/
export const aggregateWithinEither = internal.aggregateWithinEither;
/**
* Maps the success values of this stream to the specified constant value.
*
* @since 2.0.0
* @category mapping
*/
export const as = internal.as;
const _async = internal._async;
export {
/**
* Creates a stream from an asynchronous callback that can be called multiple
* times. The optionality of the error type `E` in `Emit` can be used to
* signal the end of the stream by setting it to `None`.
*
* The registration function can optionally return an `Effect`, which will be
* executed if the `Fiber` executing this Effect is interrupted.
*
* @since 2.0.0
* @category constructors
*/
_async as async };
/**
* Creates a stream from an asynchronous callback that can be called multiple
* times The registration of the callback itself returns an effect. The
* optionality of the error type `E` can be used to signal the end of the
* stream, by setting it to `None`.
*
* @since 2.0.0
* @category constructors
*/
export const asyncEffect = internal.asyncEffect;
/**
* Creates a stream from an asynchronous callback that can be called multiple
* times. The registration of the callback itself returns an a scoped
* resource. The optionality of the error type `E` can be used to signal the
* end of the stream, by setting it to `None`.
*
* @since 2.0.0
* @category constructors
*/
export const asyncScoped = internal.asyncScoped;
/**
* Returns a `Stream` that first collects `n` elements from the input `Stream`,
* and then creates a new `Stream` using the specified function, and sends all
* the following elements through that.
*
* @since 2.0.0
* @category sequencing
*/
export const branchAfter = internal.branchAfter;
/**
* Fan out the stream, producing a list of streams that have the same elements
* as this stream. The driver stream will only ever advance the `maximumLag`
* chunks before the slowest downstream stream.
*
* @since 2.0.0
* @category utils
*/
export const broadcast = internal.broadcast;
/**
* Fan out the stream, producing a dynamic number of streams that have the
* same elements as this stream. The driver stream will only ever advance the
* `maximumLag` chunks before the slowest downstream stream.
*
* @since 2.0.0
* @category utils
*/
export const broadcastDynamic = internal.broadcastDynamic;
/**
* Converts the stream to a scoped list of queues. Every value will be
* replicated to every queue with the slowest queue being allowed to buffer
* `maximumLag` chunks before the driver is back pressured.
*
* Queues can unsubscribe from upstream by shutting down.
*
* @since 2.0.0
* @category utils
*/
export const broadcastedQueues = internal.broadcastedQueues;
/**
* Converts the stream to a scoped dynamic amount of queues. Every chunk will
* be replicated to every queue with the slowest queue being allowed to buffer
* `maximumLag` chunks before the driver is back pressured.
*
* Queues can unsubscribe from upstream by shutting down.
*
* @since 2.0.0
* @category utils
*/
export const broadcastedQueuesDynamic = internal.broadcastedQueuesDynamic;
/**
* Allows a faster producer to progress independently of a slower consumer by
* buffering up to `capacity` elements in a queue.
*
* @note This combinator destroys the chunking structure. It's recommended to
* use rechunk afterwards. Additionally, prefer capacities that are powers
* of 2 for better performance.
* @since 2.0.0
* @category utils
*/
export const buffer = internal.buffer;
/**
* Allows a faster producer to progress independently of a slower consumer by
* buffering up to `capacity` chunks in a queue.
*
* @note Prefer capacities that are powers of 2 for better performance.
* @since 2.0.0
* @category utils
*/
export const bufferChunks = internal.bufferChunks;
/**
* Switches over to the stream produced by the provided function in case this
* one fails with a typed error.
*
* @since 2.0.0
* @category error handling
*/
export const catchAll = internal.catchAll;
/**
* Switches over to the stream produced by the provided function in case this
* one fails. Allows recovery from all causes of failure, including
* interruption if the stream is uninterruptible.
*
* @since 2.0.0
* @category error handling
*/
export const catchAllCause = internal.catchAllCause;
/**
* Switches over to the stream produced by the provided function in case this
* one fails with some typed error.
*
* @since 2.0.0
* @category error handling
*/
export const catchSome = internal.catchSome;
/**
* Switches over to the stream produced by the provided function in case this
* one fails with an error matching the given `_tag`.
*
* @since 2.0.0
* @category error handling
*/
export const catchTag = internal.catchTag;
/**
* Switches over to the stream produced by one of the provided functions, in
* case this one fails with an error matching one of the given `_tag`'s.
*
* @since 2.0.0
* @category error handling
*/
export const catchTags = internal.catchTags;
/**
* Switches over to the stream produced by the provided function in case this
* one fails with some errors. Allows recovery from all causes of failure,
* including interruption if the stream is uninterruptible.
*
* @since 2.0.0
* @category error handling
*/
export const catchSomeCause = internal.catchSomeCause;
/**
* Returns a new stream that only emits elements that are not equal to the
* previous element emitted, using natural equality to determine whether two
* elements are equal.
*
* @since 2.0.0
* @category utils
*/
export const changes = internal.changes;
/**
* Returns a new stream that only emits elements that are not equal to the
* previous element emitted, using the specified function to determine whether
* two elements are equal.
*
* @since 2.0.0
* @category utils
*/
export const changesWith = internal.changesWith;
/**
* Returns a new stream that only emits elements that are not equal to the
* previous element emitted, using the specified effectual function to
* determine whether two elements are equal.
*
* @since 2.0.0
* @category utils
*/
export const changesWithEffect = internal.changesWithEffect;
/**
* Exposes the underlying chunks of the stream as a stream of chunks of
* elements.
*
* @since 2.0.0
* @category utils
*/
export const chunks = internal.chunks;
/**
* Performs the specified stream transformation with the chunk structure of
* the stream exposed.
*
* @since 2.0.0
* @category utils
*/
export const chunksWith = internal.chunksWith;
/**
* Combines the elements from this stream and the specified stream by
* repeatedly applying the function `f` to extract an element using both sides
* and conceptually "offer" it to the destination stream. `f` can maintain
* some internal state to control the combining process, with the initial
* state being specified by `s`.
*
* Where possible, prefer `Stream.combineChunks` for a more efficient
* implementation.
*
* @since 2.0.0
* @category utils
*/
export const combine = internal.combine;
/**
* Combines the chunks from this stream and the specified stream by repeatedly
* applying the function `f` to extract a chunk using both sides and
* conceptually "offer" it to the destination stream. `f` can maintain some
* internal state to control the combining process, with the initial state
* being specified by `s`.
*
* @since 2.0.0
* @category utils
*/
export const combineChunks = internal.combineChunks;
/**
* Concatenates the specified stream with this stream, resulting in a stream
* that emits the elements from this stream and then the elements from the
* specified stream.
*
* @since 2.0.0
* @category utils
*/
export const concat = internal.concat;
/**
* Concatenates all of the streams in the chunk to one stream.
*
* @since 2.0.0
* @category constructors
*/
export const concatAll = internal.concatAll;
/**
* Composes this stream with the specified stream to create a cartesian
* product of elements. The `that` stream would be run multiple times, for
* every element in the `this` stream.
*
* See also `Stream.zip` for the more common point-wise variant.
*
* @since 2.0.0
* @category utils
*/
export const cross = internal.cross;
/**
* Composes this stream with the specified stream to create a cartesian
* product of elements, but keeps only elements from this stream. The `that`
* stream would be run multiple times, for every element in the `this` stream.
*
* See also `Stream.zipLeft` for the more common point-wise variant.
*
* @since 2.0.0
* @category utils
*/
export const crossLeft = internal.crossLeft;
/**
* Composes this stream with the specified stream to create a cartesian
* product of elements, but keeps only elements from the other stream. The
* `that` stream would be run multiple times, for every element in the `this`
* stream.
*
* See also `Stream.zipRight` for the more common point-wise variant.
*
* @since 2.0.0
* @category utils
*/
export const crossRight = internal.crossRight;
/**
* Composes this stream with the specified stream to create a cartesian
* product of elements with a specified function. The `that` stream would be
* run multiple times, for every element in the `this` stream.
*
* See also `Stream.zipWith` for the more common point-wise variant.
*
* @since 2.0.0
* @category utils
*/
export const crossWith = internal.crossWith;
/**
* Delays the emission of values by holding new values for a set duration. If
* no new values arrive during that time the value is emitted, however if a
* new value is received during the holding period the previous value is
* discarded and the process is repeated with the new value.
*
* This operator is useful if you have a stream of "bursty" events which
* eventually settle down and you only need the final event of the burst. For
* example, a search engine may only want to initiate a search after a user
* has paused typing so as to not prematurely recommend results.
*
* @since 2.0.0
* @category utils
*/
export const debounce = internal.debounce;
/**
* The stream that dies with the specified defect.
*
* @since 2.0.0
* @category constructors
*/
export const die = internal.die;
/**
* The stream that dies with the specified lazily evaluated defect.
*
* @since 2.0.0
* @category constructors
*/
export const dieSync = internal.dieSync;
/**
* The stream that dies with an exception described by `message`.
*
* @since 2.0.0
* @category constructors
*/
export const dieMessage = internal.dieMessage;
/**
* More powerful version of `Stream.broadcast`. Allows to provide a function
* that determines what queues should receive which elements. The decide
* function will receive the indices of the queues in the resulting list.
*
* @since 2.0.0
* @category utils
*/
export const distributedWith = internal.distributedWith;
/**
* More powerful version of `Stream.distributedWith`. This returns a function
* that will produce new queues and corresponding indices. You can also
* provide a function that will be executed after the final events are
* enqueued in all queues. Shutdown of the queues is handled by the driver.
* Downstream users can also shutdown queues manually. In this case the driver
* will continue but no longer backpressure on them.
*
* @since 2.0.0
* @category utils
*/
export const distributedWithDynamic = internal.distributedWithDynamic;
/**
* Converts this stream to a stream that executes its effects but emits no
* elements. Useful for sequencing effects using streams:
*
* @since 2.0.0
* @category utils
*/
export const drain = internal.drain;
/**
* Drains the provided stream in the background for as long as this stream is
* running. If this stream ends before `other`, `other` will be interrupted.
* If `other` fails, this stream will fail with that error.
*
* @since 2.0.0
* @category utils
*/
export const drainFork = internal.drainFork;
/**
* Drops the specified number of elements from this stream.
*
* @since 2.0.0
* @category utils
*/
export const drop = internal.drop;
/**
* Drops the last specified number of elements from this stream.
*
* @note This combinator keeps `n` elements in memory. Be careful with big
* numbers.
* @since 2.0.0
* @category utils
*/
export const dropRight = internal.dropRight;
/**
* Drops all elements of the stream until the specified predicate evaluates to
* `true`.
*
* @since 2.0.0
* @category utils
*/
export const dropUntil = internal.dropUntil;
/**
* Drops all elements of the stream until the specified effectful predicate
* evaluates to `true`.
*
* @since 2.0.0
* @category utils
*/
export const dropUntilEffect = internal.dropUntilEffect;
/**
* Drops all elements of the stream for as long as the specified predicate
* evaluates to `true`.
*
* @since 2.0.0
* @category utils
*/
export const dropWhile = internal.dropWhile;
/**
* Drops all elements of the stream for as long as the specified predicate
* produces an effect that evalutates to `true`
*
* @since 2.0.0
* @category utils
*/
export const dropWhileEffect = internal.dropWhileEffect;
/**
* Returns a stream whose failures and successes have been lifted into an
* `Either`. The resulting stream cannot fail, because the failures have been
* exposed as part of the `Either` success case.
*
* @note The stream will end as soon as the first error occurs.
*
* @since 2.0.0
* @category utils
*/
export const either = internal.either;
/**
* The empty stream.
*
* @since 2.0.0
* @category constructors
*/
export const empty = internal.empty;
/**
* Executes the provided finalizer after this stream's finalizers run.
*
* @since 2.0.0
* @category utils
*/
export const ensuring = internal.ensuring;
/**
* Executes the provided finalizer after this stream's finalizers run.
*
* @since 2.0.0
* @category utils
*/
export const ensuringWith = internal.ensuringWith;
/**
* Accesses the whole context of the stream.
*
* @since 2.0.0
* @category context
*/
export const context = internal.context;
/**
* Accesses the context of the stream.
*
* @since 2.0.0
* @category context
*/
export const contextWith = internal.contextWith;
/**
* Accesses the context of the stream in the context of an effect.
*
* @since 2.0.0
* @category context
*/
export const contextWithEffect = internal.contextWithEffect;
/**
* Accesses the context of the stream in the context of a stream.
*
* @since 2.0.0
* @category context
*/
export const contextWithStream = internal.contextWithStream;
/**
* Creates a stream that executes the specified effect but emits no elements.
*
* @since 2.0.0
* @category constructors
*/
export const execute = internal.execute;
/**
* Terminates with the specified error.
*
* @since 2.0.0
* @category constructors
*/
export const fail = internal.fail;
/**
* Terminates with the specified lazily evaluated error.
*
* @since 2.0.0
* @category constructors
*/
export const failSync = internal.failSync;
/**
* The stream that always fails with the specified `Cause`.
*
* @since 2.0.0
* @category constructors
*/
export const failCause = internal.failCause;
/**
* The stream that always fails with the specified lazily evaluated `Cause`.
*
* @since 2.0.0
* @category constructors
*/
export const failCauseSync = internal.failCauseSync;
/**
* Filters the elements emitted by this stream using the provided function.
*
* @since 2.0.0
* @category filtering
*/
export const filter = internal.filter;
/**
* Effectfully filters the elements emitted by this stream.
*
* @since 2.0.0
* @category filtering
*/
export const filterEffect = internal.filterEffect;
/**
* Performs a filter and map in a single step.
*
* @since 2.0.0
* @category utils
*/
export const filterMap = internal.filterMap;
/**
* Performs an effectful filter and map in a single step.
*
* @since 2.0.0
* @category utils
*/
export const filterMapEffect = internal.filterMapEffect;
/**
* Transforms all elements of the stream for as long as the specified partial
* function is defined.
*
* @since 2.0.0
* @category utils
*/
export const filterMapWhile = internal.filterMapWhile;
/**
* Effectfully transforms all elements of the stream for as long as the
* specified partial function is defined.
*
* @since 2.0.0
* @category utils
*/
export const filterMapWhileEffect = internal.filterMapWhileEffect;
/**
* Creates a one-element stream that never fails and executes the finalizer
* when it ends.
*
* @since 2.0.0
* @category constructors
*/
export const finalizer = internal.finalizer;
/**
* Finds the first element emitted by this stream that satisfies the provided
* predicate.
*
* @since 2.0.0
* @category elements
*/
export const find = internal.find;
/**
* Finds the first element emitted by this stream that satisfies the provided
* effectful predicate.
*
* @since 2.0.0
* @category elements
*/
export const findEffect = internal.findEffect;
/**
* Returns a stream made of the concatenation in strict order of all the
* streams produced by passing each element of this stream to `f0`
*
* @since 2.0.0
* @category sequencing
*/
export const flatMap = internal.flatMap;
/**
* Flattens this stream-of-streams into a stream made of the concatenation in
* strict order of all the streams.
*
* @since 2.0.0
* @category sequencing
*/
export const flatten = internal.flatten;
/**
* Submerges the chunks carried by this stream into the stream's structure,
* while still preserving them.
*
* @since 2.0.0
* @category sequencing
*/
export const flattenChunks = internal.flattenChunks;
/**
* Flattens `Effect` values into the stream's structure, preserving all
* information about the effect.
*
* @since 2.0.0
* @category sequencing
*/
export const flattenEffect = internal.flattenEffect;
/**
* Unwraps `Exit` values that also signify end-of-stream by failing with `None`.
*
* For `Exit` values that do not signal end-of-stream, prefer:
*
* ```ts
* stream.mapZIO(ZIO.done(_))
* ```
*
* @since 2.0.0
* @category sequencing
*/
export const flattenExitOption = internal.flattenExitOption;
/**
* Submerges the iterables carried by this stream into the stream's structure,
* while still preserving them.
*
* @since 2.0.0
* @category sequencing
*/
export const flattenIterables = internal.flattenIterables;
/**
* Unwraps `Exit` values and flatten chunks that also signify end-of-stream
* by failing with `None`.
*
* @since 2.0.0
* @category sequencing
*/
export const flattenTake = internal.flattenTake;
/**
* Repeats this stream forever.
*
* @since 2.0.0
* @category utils
*/
export const forever = internal.forever;
/**
* Creates a stream from an `AsyncIterable`.
*
* @since 2.0.0
* @category constructors
*/
export const fromAsyncIterable = internal.fromAsyncIterable;
/**
* Creates a stream from a `Channel`.
*
* @since 2.0.0
* @category constructors
*/
export const fromChannel = internal.fromChannel;
/**
* Creates a channel from a `Stream`.
*
* @since 2.0.0
* @category constructors
*/
export const toChannel = internal.toChannel;
/**
* Creates a stream from a `Chunk` of values.
*
* @since 2.0.0
* @category constructors
*/
export const fromChunk = internal.fromChunk;
/**
* Creates a stream from a subscription to a `PubSub`.
*
* @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
* @since 2.0.0
* @category constructors
*/
export const fromChunkPubSub = internal.fromChunkPubSub;
/**
* Creates a stream from a `Queue` of values.
*
* @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
* @since 2.0.0
* @category constructors
*/
export const fromChunkQueue = internal.fromChunkQueue;
/**
* Creates a stream from an arbitrary number of chunks.
*
* @since 2.0.0
* @category constructors
*/
export const fromChunks = internal.fromChunks;
/**
* Either emits the success value of this effect or terminates the stream
* with the failure value of this effect.
*
* @since 2.0.0
* @category constructors
*/
export const fromEffect = internal.fromEffect;
/**
* Creates a stream from an effect producing a value of type `A` or an empty
* `Stream`.
*
* @since 2.0.0
* @category constructors
*/
export const fromEffectOption = internal.fromEffectOption;
/**
* Creates a stream from a subscription to a `PubSub`.
*
* @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
* @since 2.0.0
* @category constructors
*/
export const fromPubSub = internal.fromPubSub;
/**
* Creates a new `Stream` from an iterable collection of values.
*
* @since 2.0.0
* @category constructors
*/
export const fromIterable = internal.fromIterable;
/**
* Creates a stream from an effect producing a value of type `Iterable<A>`.
*
* @since 2.0.0
* @category constructors
*/
export const fromIterableEffect = internal.fromIterableEffect;
/**
* Creates a stream from an iterator
*
* @since 2.0.0
* @category constructors
*/
export const fromIteratorSucceed = internal.fromIteratorSucceed;
/**
* Creates a stream from an effect that pulls elements from another stream.
*
* See `Stream.toPull` for reference.
*
* @since 2.0.0
* @category constructors
*/
export const fromPull = internal.fromPull;
/**
* Creates a stream from a queue of values
*
* @param maxChunkSize The maximum number of queued elements to put in one chunk in the stream
* @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
* @since 2.0.0
* @category constructors
*/
export const fromQueue = internal.fromQueue;
/**
* Creates a stream from a `ReadableStream`.
*
* See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream.
*
* @since 2.0.0
* @category constructors
*/
export const fromReadableStream = internal.fromReadableStream;
/**
* Creates a stream from a `ReadableStreamBYOBReader`.
*
* See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader.
*
* @param allocSize Controls the size of the underlying `ArrayBuffer` (defaults to `4096`).
* @since 2.0.0
* @category constructors
*/
export const fromReadableStreamByob = internal.fromReadableStreamByob;
/**
* Creates a stream from a `Schedule` that does not require any further
* input. The stream will emit an element for each value output from the
* schedule, continuing for as long as the schedule continues.
*
* @since 2.0.0
* @category constructors
*/
export const fromSchedule = internal.fromSchedule;
/**
* Creates a pipeline that groups on adjacent keys, calculated by the
* specified function.
*
* @since 2.0.0
* @category grouping
*/
export const groupAdjacentBy = internal.groupAdjacentBy;
/**
* More powerful version of `Stream.groupByKey`.
*
* @since 2.0.0
* @category grouping
*/
export const groupBy = _groupBy.groupBy;
/**
* Partition a stream using a function and process each stream individually.
* This returns a data structure that can be used to further filter down which
* groups shall be processed.
*
* After calling apply on the GroupBy object, the remaining groups will be
* processed in parallel and the resulting streams merged in a
* nondeterministic fashion.
*
* Up to `buffer` elements may be buffered in any group stream before the
* producer is backpressured. Take care to consume from all streams in order
* to prevent deadlocks.
*
* For example, to collect the first 2 words for every starting letter from a
* stream of words:
*
* ```ts
* import * as GroupBy from "./GroupBy"
* import * as Stream from "./Stream"
* import { pipe } from "./Function"
*
* pipe(
* Stream.fromIterable(["hello", "world", "hi", "holla"]),
* Stream.groupByKey((word) => word[0]),
* GroupBy.evaluate((key, stream) =>
* pipe(
* stream,
* Stream.take(2),
* Stream.map((words) => [key, words] as const)
* )
* )
* )
* ```
*
* @since 2.0.0
* @category utils
*/
export const groupByKey = _groupBy.groupByKey;
/**
* Partitions the stream with specified `chunkSize`.
*
* @since 2.0.0
* @category utils
*/
export const grouped = internal.grouped;
/**
* Partitions the stream with the specified `chunkSize` or until the specified
* `duration` has passed, whichever is satisfied first.
*
* @since 2.0.0
* @category utils
*/
export const groupedWithin = internal.groupedWithin;
/**
* Specialized version of haltWhen which halts the evaluation of this stream
* after the given duration.
*
* An element in the process of being pulled will not be interrupted when the
* given duration completes. See `interruptAfter` for this behavior.
*
* @since 2.0.0
* @category utils
*/
export const haltAfter = internal.haltAfter;
/**
* Halts the evaluation of this stream when the provided effect completes. The
* given effect will be forked as part of the returned stream, and its success
* will be discarded.
*
* An element in the process of being pulled will not be interrupted when the
* effect completes. See `interruptWhen` for this behavior.
*
* If the effect completes with a failure, the stream will emit that failure.
*
* @since 2.0.0
* @category utils
*/
export const haltWhen = internal.haltWhen;
/**
* Halts the evaluation of this stream when the provided promise resolves.
*
* If the promise completes with a failure, the stream will emit that failure.
*
* @since 2.0.0
* @category utils
*/
export const haltWhenDeferred = internal.haltWhenDeferred;
/**
* The identity pipeline, which does not modify streams in any way.
*
* @since 2.0.0
* @category utils
*/
export const identity = internal.identityStream;
/**
* Interleaves this stream and the specified stream deterministically by
* alternating pulling values from this stream and the specified stream. When
* one stream is exhausted all remaining values in the other stream will be
* pulled.
*
* @since 2.0.0
* @category utils
*/
export const interleave = internal.interleave;
/**
* Combines this stream and the specified stream deterministically using the
* stream of boolean values `pull` to control which stream to pull from next.
* A value of `true` indicates to pull from this stream and a value of `false`
* indicates to pull from the specified stream. Only consumes as many elements
* as requested by the `pull` stream. If either this stream or the specified
* stream are exhausted further requests for values from that stream will be
* ignored.
*
* @since 2.0.0
* @category utils
*/
export const interleaveWith = internal.interleaveWith;
/**
* Intersperse stream with provided `element`.
*
* @since 2.0.0
* @category utils
*/
export const intersperse = internal.intersperse;
/**
* Intersperse the specified element, also adding a prefix and a suffix.
*
* @since 2.0.0
* @category utils
*/
export const intersperseAffixes = internal.intersperseAffixes;
/**
* Specialized version of `Stream.interruptWhen` which interrupts the
* evaluation of this stream after the given `Duration`.
*
* @since 2.0.0
* @category utils
*/
export const interruptAfter = internal.interruptAfter;
/**
* Interrupts the evaluation of this stream when the provided effect
* completes. The given effect will be forked as part of this stream, and its
* success will be discarded. This combinator will also interrupt any
* in-progress element being pulled from upstream.
*
* If the effect completes with a failure before the stream completes, the
* returned stream will emit that failure.
*
* @since 2.0.0
* @category utils
*/
export const interruptWhen = internal.interruptWhen;
/**
* Interrupts the evaluation of this stream when the provided promise
* resolves. This combinator will also interrupt any in-progress element being
* pulled from upstream.
*
* If the promise completes with a failure, the stream will emit that failure.
*
* @since 2.0.0
* @category utils
*/
export const interruptWhenDeferred = internal.interruptWhenDeferred;
/**
* The infinite stream of iterative function application: a, f(a), f(f(a)),
* f(f(f(a))), ...
*
* @since 2.0.0
* @category constructors
*/
export const iterate = internal.iterate;
/**
* Creates a stream from an sequence of values.
*
* @since 2.0.0
* @category constructors
*/
export const make = internal.make;
/**
* Transforms the elements of this stream using the supplied function.
*
* @since 2.0.0
* @category mapping
*/
export const map = internal.map;
/**
* Statefully maps over the elements of this stream to produce new elements.
*
* @since 2.0.0
* @category mapping
*/
export const mapAccum = internal.mapAccum;
/**
* Statefully and effectfully maps over the elements of this stream to produce
* new elements.
*
* @since 2.0.0
* @category mapping
*/
export const mapAccumEffect = internal.mapAccumEffect;
/**
* Returns a stream whose failure and success channels have been mapped by the
* specified `onFailure` and `onSuccess` functions.
*
* @since 2.0.0
* @category utils
*/
export const mapBoth = internal.mapBoth;
/**
* Transforms the chunks emitted by this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapChunks = internal.mapChunks;
/**
* Effectfully transforms the chunks emitted by this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapChunksEffect = internal.mapChunksEffect;
/**
* Maps each element to an iterable, and flattens the iterables into the
* output of this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapConcat = internal.mapConcat;
/**
* Maps each element to a chunk, and flattens the chunks into the output of
* this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapConcatChunk = internal.mapConcatChunk;
/**
* Effectfully maps each element to a chunk, and flattens the chunks into the
* output of this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapConcatChunkEffect = internal.mapConcatChunkEffect;
/**
* Effectfully maps each element to an iterable, and flattens the iterables
* into the output of this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapConcatEffect = internal.mapConcatEffect;
/**
* Maps over elements of the stream with the specified effectful function.
*
* @since 2.0.0
* @category mapping
*/
export const mapEffect = _groupBy.mapEffectOptions;
/**
* Transforms the errors emitted by this stream using `f`.
*
* @since 2.0.0
* @category mapping
*/
export const mapError = internal.mapError;
/**
* Transforms the full causes of failures emitted by this stream.
*
* @since 2.0.0
* @category mapping
*/
export const mapErrorCause = internal.mapErrorCause;
/**
* Merges this stream and the specified stream together.
*
* New produced stream will terminate when both specified stream terminate if
* no termination strategy is specified.
*
* @since 2.0.0
* @category utils
*/
export const merge = internal.merge;
/**
* Merges a variable list of streams in a non-deterministic fashion. Up to `n`
* streams may be consumed in parallel and up to `outputBuffer` chunks may be
* buffered by this operator.
*
* @since 2.0.0
* @category utils
*/
export const mergeAll = internal.mergeAll;
/**
* Merges this stream and the specified stream together to a common element
* type with the specified mapping functions.
*
* New produced stream will terminate when both specified stream terminate if
* no termination strategy is specified.
*
* @since 2.0.0
* @category utils
*/
export const mergeWith = internal.mergeWith;
/**
* Merges this stream and the specified stream together to produce a stream of
* eithers.
*
* @since 2.0.0
* @category utils
*/
export const mergeEither = internal.mergeEither;
/**
* Merges this stream and the specified stream together, discarding the values
* from the right stream.
*
* @since 2.0.0
* @category utils
*/
export const mergeLeft = internal.mergeLeft;
/**
* Merges this stream and the specified stream together, discarding the values
* from the left stream.
*
* @since 2.0.0
* @category utils
*/
export const mergeRight = internal.mergeRight;
/**
* Returns a combined string resulting from concatenating each of the values
* from the stream.
*
* @since 2.0.0
* @category utils
*/
export const mkString = internal.mkString;
/**
* The stream that never produces any value or fails with any error.
*
* @since 2.0.0
* @category constructors
*/
export const never = internal.never;
/**
* Runs the specified effect if this stream fails, providing the error to the
* effect if it exists.
*
* Note: Unlike `Effect.onError` there is no guarantee that the provided
* effect will not be interrupted.
*
* @since 2.0.0
* @category utils
*/
export const onError = internal.onError;
/**
* Runs the specified effect if this stream ends.
*
* @since 2.0.0
* @category utils
*/
export const onDone = internal.onDone;
/**
* Translates any failure into a stream termination, making the stream
* infallible and all failures unchecked.
*
* @since 2.0.0
* @category error handling
*/
export const orDie = internal.orDie;
/**
* Keeps none of the errors, and terminates the stream with them, using the
* specified function to convert the `E` into a defect.
*
* @since 2.0.0
* @category error handling
*/
export const orDieWith = internal.orDieWith;
/**
* Switches to the provided stream in case this one fails with a typed error.
*
* See also `Stream.catchAll`.
*
* @since 2.0.0
* @category error handling
*/
export const orElse = internal.orElse;
/**
* Switches to the provided stream in case this one fails with a typed error.
*
* See also `Stream.catchAll`.
*
* @since 2.0.0
* @category error handling
*/
export const orElseEither = internal.orElseEither;
/**
* Fails with given error in case this one fails with a typed error.
*
* See also `Stream.catchAll`.
*
* @since 2.0.0
* @category error handling
*/
export const orElseFail = internal.orElseFail;
/**
* Produces the specified element if this stream is empty.
*
* @since 2.0.0
* @category error handling
*/
export const orElseIfEmpty = internal.orElseIfEmpty;
/**
* Produces the specified chunk if this stream is empty.
*
* @since 2.0.0
* @category error handling
*/
export const orElseIfEmptyChunk = internal.orElseIfEmptyChunk;
/**
* Switches to the provided stream in case this one is empty.
*
* @since 2.0.0
* @category error handling
*/
export const orElseIfEmptyStream = internal.orElseIfEmptyStream;
/**
* Succeeds with the specified value if this one fails with a typed error.
*
* @since 2.0.0
* @category error handling
*/
export const orElseSucceed = internal.orElseSucceed;
/**
* Like `Stream.unfold`, but allows the emission of values to end one step further
* than the unfolding of the state. This is useful for embedding paginated
* APIs, hence the name.
*
* @since 2.0.0
* @category constructors
*/
export const paginate = internal.paginate;
/**
* Like `Stream.unfoldChunk`, but allows the emission of values to end one step
* further than the unfolding of the state. This is useful for embedding
* paginated APIs, hence the name.
*
* @since 2.0.0
* @category constructors
*/
export const paginateChunk = internal.paginateChunk;
/**
* Like `Stream.unfoldChunkEffect`, but allows the emission of values to end one step
* further than the unfolding of the state. This is useful for embedding
* paginated APIs, hence the name.
*
* @since 2.0.0
* @category constructors
*/
export const paginateChunkEffect = internal.paginateChunkEffect;
/**
* Like `Stream.unfoldEffect` but allows the emission of values to end one step
* further than the unfolding of the state. This is useful for embedding
* paginated APIs, hence the name.
*
* @since 2.0.0
* @category constructors
*/
export const paginateEffect = internal.paginateEffect;
/**
* Partition a stream using a predicate. The first stream will contain all
* element evaluated to true and the second one will contain all element
* evaluated to false. The faster stream may advance by up to buffer elements
* further than the slower one.
*
* @since 2.0.0
* @category utils
*/
export const partition = internal.partition;
/**
* Split a stream by an effectful predicate. The faster stream may advance by
* up to buffer elements further than the slower one.
*
* @since 2.0.0
* @category utils
*/
export const partitionEither = internal.partitionEither;
/**
* Peels off enough material from the stream to construct a `Z` using the
* provided `Sink` and then returns both the `Z` and the rest of the
* `Stream` in a scope. Like all scoped values, the provided stream is
* valid only within the scope.
*
* @since 2.0.0
* @category utils
*/
export const peel = internal.peel;
/**
* Pipes all of the values from this stream through the provided sink.
*
* See also `Stream.transduce`.
*
* @since 2.0.0
* @category utils
*/
export const pipeThrough = internal.pipeThrough;
/**
* Pipes all the values from this stream through the provided channel.
*
* @since 2.0.0
* @category utils
*/
export const pipeThroughChannel = internal.pipeThroughChannel;
/**
* Pipes all values from this stream through the provided channel, passing
* through any error emitted by this stream unchanged.
*
* @since 2.0.0
* @category utils
*/
export const pipeThroughChannelOrFail = internal.pipeThroughChannelOrFail;
/**
* Emits the provided chunk before emitting any other value.
*
* @since 2.0.0
* @category utils
*/
export const prepend = internal.prepend;
/**
* Provides the stream with its required context, which eliminates its
* dependency on `R`.
*
* @since 2.0.0
* @category context
*/
export const provideContext = internal.provideContext;
/**
* Provides a `Layer` to the stream, which translates it to another level.
*
* @since 2.0.0
* @category context
*/
export const provideLayer = internal.provideLayer;
/**
* Provides the stream with the single service it requires. If the stream
* requires more than one service use `Stream.provideContext` instead.
*
* @since 2.0.0
* @category context
*/
export const provideService = internal.provideService;
/**
* Provides the stream with the single service it requires. If the stream
* requires more than one service use `Stream.provideContext` instead.
*
* @since 2.0.0
* @category context
*/
export const provideServiceEffect = internal.provideServiceEffect;
/**
* Provides the stream with the single service it requires. If the stream
* requires more than one service use `Stream.provideContext` instead.
*
* @since 2.0.0
* @category context
*/
export const provideServiceStream = internal.provideServiceStream;
/**
* Transforms the context being provided to the stream with the specified
* function.
*
* @since 2.0.0
* @category context
*/
export const mapInputContext = internal.mapInputContext;
/**
* Splits the context into two parts, providing one part using the
* specified layer and leaving the remainder `R0`.
*
* @since 2.0.0
* @category context
*/
export const provideSomeLayer = internal.provideSomeLayer;
/**
* Constructs a stream from a range of integers, including both endpoints.
*
* @since 2.0.0
* @category constructors
*/
export const range = internal.range;
/**
* Re-chunks the elements of the stream into chunks of `n` elements each. The
* last chunk might contain less than `n` elements.
*
* @since 2.0.0
* @category utils
*/
export const rechunk = internal.rechunk;
/**
* Keeps some of the errors, and terminates the fiber with the rest
*
* @since 2.0.0
* @category error handling
*/
export const refineOrDie = internal.refineOrDie;
/**
* Keeps some of the errors, and terminates the fiber with the rest, using the
* specified function to convert the `E` into a defect.
*
* @since 2.0.0
* @category error handling
*/
export const refineOrDieWith = internal.refineOrDieWith;
/**
* Repeats the entire stream using the specified schedule. The stream will
* execute normally, and then repeat again according to the provided schedule.
*
* @since 2.0.0
* @category utils
*/
export const repeat = internal.repeat;
/**
* Creates a stream from an effect producing a value of type `A` which repeats
* forever.
*
* @since 2.0.0
* @category constructors
*/
export const repeatEffect = internal.repeatEffect;
/**
* Creates a stream from an effect producing chunks of `A` values which
* repeats forever.
*
* @since 2.0.0
* @category constructors
*/
export const repeatEffectChunk = internal.repeatEffectChunk;
/**
* Creates a stream from an effect producing chunks of `A` values until it
* fails with `None`.
*
* @since 2.0.0
* @category constructors
*/
export const repeatEffectChunkOption = internal.repeatEffectChunkOption;
/**
* Creates a stream from an effect producing values of type `A` until it fails
* with `None`.
*
* @since 2.0.0
* @category constructors
*/
export const repeatEffectOption = internal.repeatEffectOption;
/**
* Creates a stream from an effect producing a value of type `A`, which is
* repeated using the specified schedule.
*
* @since 2.0.0
* @category constructors
*/
export const repeatEffectWithSchedule = internal.repeatEffectWithSchedule;
/**
* Repeats the entire stream using the specified schedule. The stream will
* execute normally, and then repeat again according to the provided schedule.
* The schedule output will be emitted at the end of each repetition.
*
* @since 2.0.0
* @category utils
*/
export const repeatEither = internal.repeatEither;
/**
* Repeats each element of the stream using the provided schedule. Repetitions
* are done in addition to the first execution, which means using
* `Schedule.recurs(1)` actually results in the original effect, plus an
* additional recurrence, for a total of two repetitions of each value in the
* stream.
*
* @since 2.0.0
* @category utils
*/
export const repeatElements = internal.repeatElements;
/**
* Repeats each element of the stream using the provided schedule. When the
* schedule is finished, then the output of the schedule will be emitted into
* the stream. Repetitions are done in addition to the first execution, which
* means using `Schedule.recurs(1)` actually results in the original effect,
* plus an additional recurrence, for a total of two repetitions of each value
* in the stream.
*
* This function accepts two conversion functions, which allow the output of
* this stream and the output of the provided schedule to be unified into a
* single type. For example, `Either` or similar data type.
*
* @since 2.0.0
* @category utils
*/
export const repeatElementsWith = internal.repeatElementsWith;
/**
* Repeats the provided value infinitely.
*
* @since 2.0.0
* @category constructors
*/
export const repeatValue = internal.repeatValue;
/**
* Repeats the entire stream using the specified schedule. The stream will
* execute normally, and then repeat again according to the provided schedule.
* The schedule output will be emitted at the end of each repetition and can
* be unified with the stream elements using the provided functions.
*
* @since 2.0.0
* @category utils
*/
export const repeatWith = internal.repeatWith;
/**
* When the stream fails, retry it according to the given schedule
*
* This retries the entire stream, so will re-execute all of the stream's
* acquire operations.
*
* The schedule is reset as soon as the first element passes through the
* stream again.
*
* @param schedule A `Schedule` receiving as input the errors of the stream.
* @since 2.0.0
* @category utils
*/
export const retry = internal.retry;
/**
* Runs the sink on the stream to produce either the sink's result or an error.
*
* @since 2.0.0
* @category destructors
*/
export const run = internal.run;
/**
* Runs the stream and collects all of its elements to a chunk.
*
* @since 2.0.0
* @category destructors
*/
export const runCollect = internal.runCollect;
/**
* Runs the stream and emits the number of elements processed
*
* @since 2.0.0
* @category destructors
*/
export const runCount = internal.runCount;
/**
* Runs the stream only for its effects. The emitted elements are discarded.
*
* @since 2.0.0
* @category destructors
*/
export const runDrain = internal.runDrain;
/**
* Executes a pure fold over the stream of values - reduces all elements in
* the stream to a value of type `S`.
*
* @since 2.0.0
* @category destructors
*/
export const runFold = internal.runFold;
/**
* Executes an effectful fold over the stream of values.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldEffect = internal.runFoldEffect;
/**
* Executes a pure fold over the stream of values. Returns a scoped value that
* represents the scope of the stream.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldScoped = internal.runFoldScoped;
/**
* Executes an effectful fold over the stream of values. Returns a scoped
* value that represents the scope of the stream.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldScopedEffect = internal.runFoldScopedEffect;
/**
* Reduces the elements in the stream to a value of type `S`. Stops the fold
* early when the condition is not fulfilled. Example:
*
* @since 2.0.0
* @category destructors
*/
export const runFoldWhile = internal.runFoldWhile;
/**
* Executes an effectful fold over the stream of values. Stops the fold early
* when the condition is not fulfilled.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldWhileEffect = internal.runFoldWhileEffect;
/**
* Executes a pure fold over the stream of values. Returns a scoped value that
* represents the scope of the stream. Stops the fold early when the condition
* is not fulfilled.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldWhileScoped = internal.runFoldWhileScoped;
/**
* Executes an effectful fold over the stream of values. Returns a scoped
* value that represents the scope of the stream. Stops the fold early when
* the condition is not fulfilled.
*
* @since 2.0.0
* @category destructors
*/
export const runFoldWhileScopedEffect = internal.runFoldWhileScopedEffect;
/**
* Consumes all elements of the stream, passing them to the specified
* callback.
*
* @since 2.0.0
* @category destructors
*/
export const runForEach = internal.runForEach;
/**
* Consumes all elements of the stream, passing them to the specified
* callback.
*
* @since 2.0.0
* @category destructors
*/
export const runForEachChunk = internal.runForEachChunk;
/**
* Like `Stream.runForEachChunk`, but returns a scoped effect so the
* finalization order can be controlled.
*
* @since 2.0.0
* @category destructors
*/
export const runForEachChunkScoped = internal.runForEachChunkScoped;
/**
* Like `Stream.forEach`, but returns a scoped effect so the finalization
* order can be controlled.
*
* @since 2.0.0
* @category destructors
*/
export const runForEachScoped = internal.runForEachScoped;
/**
* Consumes elements of the stream, passing them to the specified callback,
* and terminating consumption when the callback returns `false`.
*
* @since 2.0.0
* @category destructors
*/
export const runForEachWhile = internal.