The produce function takes a value and a "recipe function" (whose return value often depends on the base state). The recipe function is free to mutate its first argument however it wants. All mutations are only ever applied to a copy of the base state.

Like produce, but produceWithPatches always returns a tuple [nextState, patches, inversePatches] (instead of just the next state)

A hook to access the redux dispatch function.

A hook to access the redux store's state. This hook takes a selector function as an argument. The selector is called with the store state.

A hook to access the redux store.

Create an Operation that can be either resolved (or rejected) with a synchronous callback. This is the Effection equivalent of new Promise().

Pause the current operation, then runs a promise, async function, plain function, or operation within a new scope. The calling operation will be resumed (or errored) once call is completed.

Create a new Channel. Use channels to communicate between operations. In order to dispatch messages from outside an operation such as from a callback, use Signal.

Creates a new queue. Queues are unlimited in size and sending a message to a queue is always synchronous.

Create a new scope to serve as an entry point from normal JavaScript execution into Effection.

Create a new Signal

Consume an effection stream using a simple for-of loop.

Run the given function or operation when the current operation shuts down. This is equivalent to running the function or operation in a finally {} block, but it can help you avoid rightward drift.

Race the given operations against each other and return the value of whichever operation returns first. This has the same purpose as Promise.race.

Define an Effection resource

Execute an operation.

Sleep for the given amount of milliseconds.

Run another operation concurrently as a child of the current one.

Indefinitely pause execution of the current operation. It is typically used in conjunction with an action to mark the boundary between setup and teardown.

Create an AbortSignal bound to the current scope. Whenever that scope is completed, errored, or halted, the abort signal will be triggered.

Get the scope of the currently running Operation.

A broadcast channel that multiple consumers can subscribe to the via the same Stream, and messages sent to the channel are received by all consumers. The channel is not buffered, so if there are no consumers, the message is dropped.

An Operation in Effection describes an abstract computation. An operation does not do anything on its own. Rather, it only describes the steps it will take when it runs.

A FIFO queue which can be used to implement the Subscription interface directly. Most of the time, you will use either a Signal or a Channel as the mechanism, but Queue allows you to manage a single subscription directly.

A programatic API to interact with an Effection scope from outside of an Operation.

Convert plain JavaScript function calls into a Stream that can be consumed within an operation. If no operation is subscribed to a signal's stream, then sending messages to it is a no-op.

The Effection equivalent of an AsyncIterable.

The Effection equivalent of an AsyncIterator

A handle to a concurrently running operation that lets you either use the result of that operation, or shut it down.

This interface allows you to easily create a hook that is properly typed for your store's root state.