@fncts/io 0.0.1

package/Channel/api.d.ts

@@ -0,0 +1,420 @@
+import { Lazy } from "@fncts/base/data/function";
+import { Environment } from "@fncts/base/data/Environment";
+import { IO, URIO } from "@fncts/io/IO/definition";
+import { Exit } from "@fncts/base/data/Exit";
+import { Predicate } from "@fncts/base/data/Predicate";
+import { Ref } from "@fncts/io/Ref";
+import { Conc, ConcBuilder } from "@fncts/base/collection/immutable/Conc";
+import { Cause } from "@fncts/base/data/Cause";
+import { Either } from "@fncts/base/data/Either";
+import { Maybe, Nothing } from "@fncts/base/data/Maybe";
+import { FiberId } from "@fncts/base/data/FiberId";
+import { Has } from "@fncts/base/typeclass/Has";
+import { Scope } from "@fncts/io/Scope/definition";
+import type { AsyncInputConsumer } from "@fncts/io/Channel/internal/AsyncInputConsumer";
+import type { AsyncInputProducer } from "@fncts/io/Channel/internal/AsyncInputProducer";
+import type { UpstreamPullRequest } from "@fncts/io/Channel/UpstreamPullRequest";
+import { ChildExecutorDecision } from "@fncts/io/Channel/ChildExecutorDecision";
+import { Channel } from "@fncts/io/Channel/definition";
+import { UpstreamPullStrategy } from "@fncts/io/Channel/UpstreamPullStrategy";
+/**
+ * Returns a new channel that is the same as this one, except the terminal value of the channel
+ * is the specified constant value.
+ *
+ * This method produces the same result as mapping this channel to the specified constant value.
+ * @tsplus fluent fncts.io.Channel as
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function as_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, OutDone2>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, z2: Lazy<OutDone2>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone2>;
+/**
+ * @tsplus static fncts.io.ChannelOps ask
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function ask<Env>(): Channel<Env, unknown, unknown, unknown, never, never, Environment<Env>>;
+/**
+ * @tsplus getter fncts.io.Channel asUnit
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function asUnit<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, void>;
+/**
+ * @tsplus static fncts.io.ChannelOps acquireReleaseWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function acquireReleaseWith_<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone, Acquired>(acquire: IO<Env, OutErr, Acquired>, use: (a: Acquired) => Channel<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone>, release: (a: Acquired) => URIO<Env, any>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone>;
+/**
+ * @tsplus static fncts.io.ChannelOps acquireReleaseExitWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function acquireReleaseExitWith_<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone, Acquired>(acquire: IO<Env, OutErr, Acquired>, use: (a: Acquired) => Channel<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone>, release: (a: Acquired, exit: Exit<OutErr, OutDone>) => URIO<Env, any>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem1, OutDone>;
+/**
+ * Construct a resource Channel with Acquire / Release
+ * @tsplus static fncts.io.ChannelOps acquireReleaseOut
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function acquireReleaseOut_<Env, OutErr, Acquired, Z>(acquire: IO<Env, OutErr, Acquired>, release: (a: Acquired) => URIO<Env, Z>): Channel<Env, unknown, unknown, unknown, OutErr, Acquired, void>;
+/**
+ * Construct a resource Channel with Acquire / Release
+ * @tsplus static fncts.io.ChannelOps acquireReleaseOutExit
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function acquireReleaseOutExit_<R, R2, E, Z>(self: IO<R, E, Z>, release: (z: Z, e: Exit<unknown, unknown>) => URIO<R2, unknown>): Channel<R & R2, unknown, unknown, unknown, E, Z, void>;
+/**
+ * Creates a channel backed by a buffer. When the buffer is empty, the channel will simply
+ * passthrough its input as output. However, when the buffer is non-empty, the value inside
+ * the buffer will be passed along as output.
+ * @tsplus static fncts.io.ChannelOps buffer
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function buffer<InElem, InErr, InDone>(empty: InElem, isEmpty: Predicate<InElem>, ref: Ref<InElem>): Channel<unknown, InErr, InElem, InDone, InErr, InElem, InDone>;
+/**
+ * @tsplus static fncts.io.ChannelOps bufferChunk
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function bufferChunk<InElem, InErr, InDone>(ref: Ref<Conc<InElem>>): Channel<unknown, InErr, Conc<InElem>, InDone, InErr, Conc<InElem>, InDone>;
+/**
+ * Returns a new channel that is the same as this one, except if this channel errors for any
+ * typed error, then the returned channel will switch over to using the fallback channel returned
+ * by the specified error handler.
+ * @tsplus fluent fncts.io.Channel catchAll
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function catchAll_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (error: OutErr) => Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr1, OutElem | OutElem1, OutDone | OutDone1>;
+/**
+ * Returns a new channel that is the same as this one, except if this channel errors for any
+ * typed error, then the returned channel will switch over to using the fallback channel returned
+ * by the specified error handler.
+ * @tsplus fluent fncts.io.Channel catchAllCause
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function catchAllCause_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (cause: Cause<OutErr>) => Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr1, OutElem | OutElem1, OutDone | OutDone1>;
+/**
+ * @tsplus getter fncts.io.Channel concatAll
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function concatAll<Env, InErr, InElem, InDone, OutErr, OutElem>(channels: Channel<Env, InErr, InElem, InDone, OutErr, Channel<Env, InErr, InElem, InDone, OutErr, OutElem, any>, any>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, any>;
+/**
+ * Returns a new channel whose outputs are fed to the specified factory function, which creates
+ * new channels in response. These new channels are sequentially concatenated together, and all
+ * their outputs appear as outputs of the newly returned channel. The provided merging function
+ * is used to merge the terminal values of all channels into the single terminal value of the
+ * returned channel.
+ * @tsplus fluent fncts.io.Channel concatMapWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function concatMapWith_<Env, InErr, InElem, InDone, OutErr, OutElem, OutElem2, OutDone, OutDone2, OutDone3, Env2, InErr2, InElem2, InDone2, OutErr2>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone2>, f: (o: OutElem) => Channel<Env2, InErr2, InElem2, InDone2, OutErr2, OutElem2, OutDone>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3): Channel<Env & Env2, InErr & InErr2, InElem & InElem2, InDone & InDone2, OutErr | OutErr2, OutElem2, OutDone3>;
+/**
+ * Returns a new channel whose outputs are fed to the specified factory function, which creates
+ * new channels in response. These new channels are sequentially concatenated together, and all
+ * their outputs appear as outputs of the newly returned channel. The provided merging function
+ * is used to merge the terminal values of all channels into the single terminal value of the
+ * returned channel.
+ * @tsplus fluent fncts.io.Channel concatMapWithCustom
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function concatMapWithCustom_<Env, InErr, InElem, InDone, OutErr, OutElem, OutElem2, OutDone, OutDone2, OutDone3, Env2, InErr2, InElem2, InDone2, OutErr2>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone2>, f: (o: OutElem) => Channel<Env2, InErr2, InElem2, InDone2, OutErr2, OutElem2, OutDone>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3, onPull: (_: UpstreamPullRequest<OutElem>) => UpstreamPullStrategy<OutElem2>, onEmit: (_: OutElem2) => ChildExecutorDecision): Channel<Env & Env2, InErr & InErr2, InElem & InElem2, InDone & InDone2, OutErr | OutErr2, OutElem2, OutDone3>;
+/**
+ * Concat sequentially a channel of channels
+ * @tsplus fluent fncts.io.Channel concatAllWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function concatAllWith_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, OutDone2, OutDone3, Env2, InErr2, InElem2, InDone2, OutErr2>(channels: Channel<Env, InErr, InElem, InDone, OutErr, Channel<Env2, InErr2, InElem2, InDone2, OutErr2, OutElem, OutDone>, OutDone2>, f: (o: OutDone, o1: OutDone) => OutDone, g: (o: OutDone, o2: OutDone2) => OutDone3): Channel<Env & Env2, InErr & InErr2, InElem & InElem2, InDone & InDone2, OutErr | OutErr2, OutElem, OutDone3>;
+/**
+ * Returns a new channel whose outputs are fed to the specified factory function, which creates
+ * new channels in response. These new channels are sequentially concatenated together, and all
+ * their outputs appear as outputs of the newly returned channel.
+ * @tsplus fluent fncts.io.Channel concatMap
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function concatMap_<Env, InErr, InElem, InDone, OutErr, OutElem, OutElem2, OutDone, OutDone2, Env2, InErr2, InElem2, InDone2, OutErr2>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone2>, f: (o: OutElem) => Channel<Env2, InErr2, InElem2, InDone2, OutErr2, OutElem2, OutDone>): Channel<Env & Env2, InErr & InErr2, InElem & InElem2, InDone & InDone2, OutErr | OutErr2, OutElem2, unknown>;
+/**
+ * @tsplus fluent fncts.io.Channel contramap
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function contramap_<Env, InErr, InElem, InDone0, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (a: InDone0) => InDone): Channel<Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel contramapIn
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function contramapIn_<Env, InErr, InElem0, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (a: InElem0) => InElem): Channel<Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel contramapIO
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function contramapIO_<Env, Env1, InErr, InElem, InDone0, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (i: InDone0) => IO<Env1, InErr, InDone>): Channel<Env1 & Env, InErr, InElem, InDone0, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel contramapInIO
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function contramapInIO_<Env, Env1, InErr, InElem0, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (a: InElem0) => IO<Env1, InErr, InElem>): Channel<Env1 & Env, InErr, InElem0, InDone, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus static fncts.io.ChannelOps defer
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function defer<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(effect: Lazy<Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * Returns a new channel, which is the same as this one, except that all the outputs are
+ * collected and bundled into a tuple together with the terminal value of this channel.
+ *
+ * As the channel returned from this channel collects all of this channels output into an in-
+ * memory chunk, it is not safe to call this method on channels that output a large or unbounded
+ * number of values.
+ * @tsplus getter fncts.io.Channel doneCollect
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function doneCollect<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>): Channel<Env, InErr, InElem, InDone, OutErr, never, readonly [Conc<OutElem>, OutDone]>;
+/**
+ * Returns a new channel which reads all the elements from upstream's output channel
+ * and ignores them, then terminates with the upstream result value.
+ * @tsplus getter fncts.io.Channel drain
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function drain<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>): Channel<Env, InErr, InElem, InDone, OutErr, never, OutDone>;
+/**
+ * Returns a new channel that collects the output and terminal value of this channel, which it
+ * then writes as output of the returned channel.
+ * @tsplus getter fncts.io.Channel emitCollect
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function emitCollect<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>): Channel<Env, InErr, InElem, InDone, OutErr, readonly [Conc<OutElem>, OutDone], void>;
+/**
+ * @tsplus fluent fncts.io.Channel ensuring
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function ensuring_<Env, Env1, InErr, InElem, InDone, OutErr, OutElem, OutDone, Z>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, finalizer: URIO<Env1, Z>): Channel<Env & Env1, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * Returns a new channel with an attached finalizer. The finalizer is guaranteed to be executed
+ * so long as the channel begins execution (and regardless of whether or not it completes).
+ * @tsplus fluent fncts.io.Channel ensuringWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function ensuringWith_<Env, Env2, InErr, InElem, InDone, OutErr, OutElem, OutDone>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, finalizer: (e: Exit<OutErr, OutDone>) => IO<Env2, never, unknown>): Channel<Env & Env2, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * Embed inputs from continuos pulling of a producer
+ * @tsplus fluent fncts.io.Channel embedInput
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function embedInput_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, unknown, unknown, unknown, OutErr, OutElem, OutDone>, input: AsyncInputProducer<InErr, InElem, InDone>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * Halt a channel with the specified error
+ * @tsplus static fncts.io.ChannelOps fail
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fail<E>(error: Lazy<E>): Channel<unknown, unknown, unknown, unknown, E, never, never>;
+/**
+ * Halt a channel with the specified error
+ * @tsplus static fncts.io.ChannelOps failNow
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function failNow<E>(error: E): Channel<unknown, unknown, unknown, unknown, E, never, never>;
+/**
+ * Returns a new channel, which flattens the terminal value of this channel. This function may
+ * only be called if the terminal value of this channel is another channel of compatible types.
+ * @tsplus getter fncts.io.Channel flatten
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function flatten<Env, InErr, InElem, InDone, OutErr, OutElem, Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone2>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone2>>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr | OutErr1, OutElem | OutElem1, OutDone2>;
+/**
+ * @tsplus static fncts.io.ChannelOps fromEither
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fromEither<E, A>(either: Lazy<Either<E, A>>): Channel<unknown, unknown, unknown, unknown, E, never, A>;
+/**
+ * @tsplus static fncts.io.ChannelOps fromInput
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fromInput<Err, Elem, Done>(input: AsyncInputConsumer<Err, Elem, Done>): Channel<unknown, unknown, unknown, unknown, Err, Elem, Done>;
+/**
+ * Use an effect to end a channel
+ * @tsplus static fncts.io.ChannelOps fromIO
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fromIO<R, E, A>(io: IO<R, E, A>): Channel<R, unknown, unknown, unknown, E, never, A>;
+/**
+ * @tsplus static fncts.io.ChannelOps fromOption
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fromOption<A>(option: Lazy<Maybe<A>>): Channel<unknown, unknown, unknown, unknown, Nothing, never, A>;
+/**
+ * @tsplus static fncts.io.ChannelOps fromQueue
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function fromQueue<Err, Elem, Done>(queue: Queue.Dequeue<Either<Exit<Err, Done>, Elem>>): Channel<unknown, unknown, unknown, unknown, Err, Elem, Done>;
+/**
+ * Provides the channel with its required environment, which eliminates
+ * its dependency on `Env`.
+ * @tsplus fluent fncts.io.Channel provideEnvironment
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function provideEnvironment_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, env: Environment<Env>): Channel<unknown, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel contramapEnvironment
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function contramapEnvironment_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, Env0>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (env0: Environment<Env0>) => Environment<Env>): Channel<Env0, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * Halt a channel with the specified exception
+ * @tsplus static fncts.io.ChannelOps haltNow
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function haltNow(defect: unknown): Channel<unknown, unknown, unknown, unknown, never, never, never>;
+/**
+ * Halt a channel with the specified exception
+ * @tsplus static fncts.io.ChannelOps halt
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function halt(defect: Lazy<unknown>): Channel<unknown, unknown, unknown, unknown, never, never, never>;
+/**
+ * @tsplus static fncts.io.ChannelOps id
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function id<Err, Elem, Done>(): Channel<unknown, Err, Elem, Done, Err, Elem, Done>;
+/**
+ * @tsplus static fncts.io.ChannelOps interrupt
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function interrupt(fiberId: FiberId): Channel<unknown, unknown, unknown, unknown, never, never, never>;
+/**
+ * Use a managed to emit an output element
+ * @tsplus static fncts.io.ChannelOps scoped
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function scoped<R, E, A>(io: Lazy<IO<R & Has<Scope>, E, A>>): Channel<R, unknown, unknown, unknown, E, A, unknown>;
+/**
+ * Returns a new channel, which is the same as this one, except the failure value of the returned
+ * channel is created by applying the specified function to the failure value of this channel.
+ * @tsplus fluent fncts.io.Channel mapError
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function mapError_<Env, InErr, InElem, InDone, OutErr, OutErr2, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (err: OutErr) => OutErr2): Channel<Env, InErr, InElem, InDone, OutErr2, OutElem, OutDone>;
+/**
+ * A more powerful version of `mapError` which also surfaces the `Cause` of the channel failure
+ * @tsplus fluent fncts.io.Channel mapErrorCause
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function mapErrorCause_<Env, InErr, InElem, InDone, OutErr, OutErr2, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (cause: Cause<OutErr>) => Cause<OutErr2>): Channel<Env, InErr, InElem, InDone, OutErr2, OutElem, OutDone>;
+/**
+ * Returns a new channel, which is the same as this one, except the terminal value of the
+ * returned channel is created by applying the specified effectful function to the terminal value
+ * of this channel.
+ * @tsplus fluent fncts.io.Channel mapIO
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function mapIO_<Env, Env1, InErr, InElem, InDone, OutErr, OutErr1, OutElem, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (o: OutDone) => IO<Env1, OutErr1, OutDone1>): Channel<Env & Env1, InErr, InElem, InDone, OutErr | OutErr1, OutElem, OutDone1>;
+/**
+ * Maps the output of this channel using f
+ * @tsplus fluent fncts.io.Channel mapOut
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function mapOut_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, OutElem2>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (o: OutElem) => OutElem2): Channel<Env, InErr, InElem, InDone, OutErr, OutElem2, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel mapOutIO
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function mapOutIO_<Env, Env1, InErr, InElem, InDone, OutErr, OutErr1, OutElem, OutElem1, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (o: OutElem) => IO<Env1, OutErr1, OutElem1>): Channel<Env & Env1, InErr, InElem, InDone, OutErr | OutErr1, OutElem1, OutDone>;
+/**
+ * Fold the channel exposing success and full error cause
+ * @tsplus fluent fncts.io.Channel matchCauseChannel
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function matchCauseChannel_<Env, Env1, Env2, InErr, InErr1, InErr2, InElem, InElem1, InElem2, InDone, InDone1, InDone2, OutErr, OutErr2, OutErr3, OutElem, OutElem1, OutElem2, OutDone, OutDone2, OutDone3>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, onError: (c: Cause<OutErr>) => Channel<Env1, InErr1, InElem1, InDone1, OutErr2, OutElem1, OutDone2>, onSuccess: (o: OutDone) => Channel<Env2, InErr2, InElem2, InDone2, OutErr3, OutElem2, OutDone3>): Channel<Env & Env1 & Env2, InErr & InErr1 & InErr2, InElem & InElem1 & InElem2, InDone & InDone1 & InDone2, OutErr2 | OutErr3, OutElem | OutElem1 | OutElem2, OutDone2 | OutDone3>;
+export declare const never: Channel<unknown, unknown, unknown, unknown, never, never, never>;
+/**
+ * Returns a new channel that will perform the operations of this one, until failure, and then
+ * it will switch over to the operations of the specified fallback channel.
+ * @tsplus fluent fncts.io.Channel orElse
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function orElse_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, that: Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr1, OutElem | OutElem1, OutDone | OutDone1>;
+/**
+ * @tsplus fluent fncts.io.Channel orHalt
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function orHalt_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, E>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, err: E): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus fluent fncts.io.Channel orHaltWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function orHaltWith_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, E>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (e: OutErr) => E): Channel<Env, InErr, InElem, InDone, never, OutElem, OutDone>;
+/**
+ * Pipe the output of a channel into the input of another
+ * @tsplus fluent fncts.io.Channel pipeTo
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function pipeTo_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, Env1, OutErr1, OutElem1, OutDone1>(left: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, right: Channel<Env1, OutErr, OutElem, OutDone, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr, InElem, InDone, OutErr1, OutElem1, OutDone1>;
+/**
+ * @tsplus fluent fncts.io.Channel pipeToOrFail
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function pipeToOrFail_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, Env1, OutErr1, OutElem1, OutDone1>(left: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, right: Channel<Env1, never, OutElem, OutDone, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr, InElem, InDone, OutErr | OutErr1, OutElem1, OutDone1>;
+/**
+ * @tsplus static fncts.io.ChannelOps read
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function read<In>(): Channel<unknown, unknown, In, unknown, Nothing, never, In>;
+/**
+ * @tsplus static fncts.io.ChannelOps readOrFail
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function readOrFail<In, E>(e: E): Channel<unknown, unknown, In, unknown, E, never, In>;
+/**
+ * Reads an input and continue exposing both full error cause and completion
+ * @tsplus static fncts.io.ChannelOps readWithCause
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function readWithCause<Env, Env1, Env2, InErr, InElem, InDone, OutErr, OutErr1, OutErr2, OutElem, OutElem1, OutElem2, OutDone, OutDone1, OutDone2>(inp: (i: InElem) => Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, halt: (e: Cause<InErr>) => Channel<Env1, InErr, InElem, InDone, OutErr1, OutElem1, OutDone1>, done: (d: InDone) => Channel<Env2, InErr, InElem, InDone, OutErr2, OutElem2, OutDone2>): Channel<Env & Env1 & Env2, InErr, InElem, InDone, OutErr | OutErr1 | OutErr2, OutElem | OutElem1 | OutElem2, OutDone | OutDone1 | OutDone2>;
+/**
+ * Reads an input and continue exposing both error and completion
+ * @tsplus static fncts.io.ChannelOps readWith
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function readWith<Env, Env1, Env2, InErr, InElem, InDone, OutErr, OutErr1, OutErr2, OutElem, OutElem1, OutElem2, OutDone, OutDone1, OutDone2>(inp: (i: InElem) => Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, error: (e: InErr) => Channel<Env1, InErr, InElem, InDone, OutErr1, OutElem1, OutDone1>, done: (d: InDone) => Channel<Env2, InErr, InElem, InDone, OutErr2, OutElem2, OutDone2>): Channel<Env & Env1 & Env2, InErr, InElem, InDone, OutErr | OutErr1 | OutErr2, OutElem | OutElem1 | OutElem2, OutDone | OutDone1 | OutDone2>;
+/**
+ * Repeats this channel forever
+ * @tsplus getter fncts.io.Channel repeated
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function repeated<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>;
+/**
+ * @tsplus static fncts.io.Channel toQueue
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function toQueue<Err, Done, Elem>(queue: Queue.Enqueue<Either<Exit<Err, Done>, Elem>>): Channel<unknown, Err, Elem, Done, never, never, any>;
+/**
+ * Writes an output to the channel
+ * @tsplus static fncts.io.ChannelOps write
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function write<OutElem>(out: Lazy<OutElem>): Channel<unknown, unknown, unknown, unknown, never, OutElem, void>;
+/**
+ * @tsplus static fncts.io.ChannelOps writeAll
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function writeAll<Out>(outs: ReadonlyArray<Out>): Channel<unknown, unknown, unknown, unknown, never, Out, void>;
+/**
+ * @tsplus static fncts.io.ChannelOps writeChunk
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function writeChunk<Out>(outs: Conc<Out>): Channel<unknown, unknown, unknown, unknown, never, Out, void>;
+/**
+ * Writes an output to the channel
+ * @tsplus static fncts.io.ChannelOps writeNow
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function writeNow<OutElem>(out: OutElem): Channel<unknown, unknown, unknown, unknown, never, OutElem, void>;
+/**
+ * @tsplus static fncts.io.ChannelOps unit
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare const unit: Channel<unknown, unknown, unknown, unknown, never, never, void>;
+/**
+ * Makes a channel from an effect that returns a channel in case of success
+ * @tsplus static fncts.io.ChannelOps unwrap
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function unwrap<R, E, Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: IO<R, E, Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>>): Channel<R & Env, InErr, InElem, InDone, E | OutErr, OutElem, OutDone>;
+/**
+ * Makes a channel from a managed that returns a channel in case of success
+ * @tsplus static fncts.io.ChannelOps unwrapScoped
+ * @tsplus location "@fncts/io/Channel/api"
+ */
+export declare function unwrapScoped<R, E, Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: IO<R & Has<Scope>, E, Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>>): Channel<R & Env, InErr, InElem, InDone, E | OutErr, OutElem, OutDone>;

package/Channel/core-api.d.ts

@@ -0,0 +1,78 @@
+import { Lazy } from "@fncts/base/data/function";
+import { Cause } from "@fncts/base/data/Cause";
+import { Channel } from "@fncts/io/Channel";
+/**
+ * Halt a channel with the specified cause
+ * @tsplus static fncts.io.ChannelOps failCause
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function failCause<E>(result: Lazy<Cause<E>>): Channel<unknown, unknown, unknown, unknown, E, never, never>;
+/**
+ * Halt a channel with the specified cause
+ * @tsplus static fncts.io.ChannelOps failCauseNow
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function failCauseNow<E>(result: Cause<E>): Channel<unknown, unknown, unknown, unknown, E, never, never>;
+/**
+ * End a channel with the specified result
+ * @tsplus static fncts.io.ChannelOps end
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function end<OutDone>(result: Lazy<OutDone>): Channel<unknown, unknown, unknown, unknown, never, never, OutDone>;
+/**
+ * End a channel with the specified result
+ * @tsplus static fncts.io.ChannelOps endNow
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function endNow<OutDone>(result: OutDone): Channel<unknown, unknown, unknown, unknown, never, never, OutDone>;
+/**
+ * End a channel with the specified result
+ * @tsplus static fncts.io.ChannelOps succeed
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function succeed<Z>(z: Lazy<Z>): Channel<unknown, unknown, unknown, unknown, never, never, Z>;
+/**
+ * End a channel with the specified result
+ * @tsplus static fncts.io.ChannelOps succeedNow
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function succeedNow<Z>(z: Z): Channel<unknown, unknown, unknown, unknown, never, never, Z>;
+/**
+ * Returns a new channel, which is the same as this one, except the terminal value of the
+ * returned channel is created by applying the specified function to the terminal value of this
+ * channel.
+ * @tsplus fluent fncts.io.Channel map
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function map_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, OutDone2>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (out: OutDone) => OutDone2): Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone2>;
+/**
+ * Returns a new channel, which sequentially combines this channel, together with the provided
+ * factory function, which creates a second channel based on the terminal value of this channel.
+ * The result is a channel that will first perform the functions of this channel, before
+ * performing the functions of the created channel (including yielding its terminal value).
+ * @tsplus fluent fncts.io.Channel flatMap
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function flatMap_<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone2>(channel: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, f: (d: OutDone) => Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone2>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr | OutErr1, OutElem | OutElem1, OutDone2>;
+/**
+ * Returns a new channel that is the sequential composition of this channel and the specified
+ * channel. The returned channel terminates with a tuple of the terminal values of both channels.
+ * @tsplus fluent fncts.io.Channel cross
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function cross_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, that: Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr | OutErr1, OutElem | OutElem1, readonly [OutDone, OutDone1]>;
+/**
+ * Returns a new channel that is the sequential composition of this channel and the specified
+ * channel. The returned channel terminates with the terminal value of this channel.
+ * @tsplus fluent fncts.io.Channel apFirst
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function apFirst_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, that: Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr | OutErr1, OutElem | OutElem1, OutDone>;
+/**
+ * Returns a new channel that is the sequential composition of this channel and the specified
+ * channel. The returned channel terminates with the terminal value of the other channel.
+ * @tsplus fluent fncts.io.Channel apSecond
+ * @tsplus operator fncts.io.Channel >
+ * @tsplus location "@fncts/io/Channel/core-api"
+ */
+export declare function apSecond_<Env, Env1, InErr, InErr1, InElem, InElem1, InDone, InDone1, OutErr, OutErr1, OutElem, OutElem1, OutDone, OutDone1>(self: Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, that: Channel<Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>): Channel<Env & Env1, InErr & InErr1, InElem & InElem1, InDone & InDone1, OutErr1 | OutErr, OutElem1 | OutElem, OutDone1>;