/actor/mod.ts | rimbu@0.10.0

import * as rimbu from "https://deno.land/x/rimbu@0.10.0/actor/mod.ts";

Namespaces

N Actor
N Command
N Obs
N ProcessQueue

Variables

Actor.from

Returns an Actor instance based on the given input Actor (which may also be an Obs), and adds the methods and properties of the given props object to it.

Functions

f Command.create	Returns a `Command` instance with the given `execute` action, and will only execute the action if the optionally given `enabled` Actor state is true.
f Obs.create	Returns an `Obs` instance with the given `initState` as initial state.
f ProcessQueue.create	Returns a new `ProcessQueue` instance.

Interfaces

I Actor	Am `Actor` that has an `Obs` instance so that its state can be observed and modified. Its main aim is to allow custom methods to be added to an `Obs`.
I Actor.Readonly	A readonly `Actor` that has a readonly `Obs` instance so that its state can be observed. Its main aim is to allow custom methods to be added to an `Obs.Readonly`.
I Command	A `Command` is an `Actor` that can execute some command optinally with some arguments, only if its state is `true`.
I Obs	An observable entity that contains potentially complex state and methods to manipulate the state.
I Obs.Readonly	A readonly observable entity that contains potentially complex state.
I ProcessQueue	An entity to manage a queue of processes to be executed.

Type Aliases

T Actor.StateType	Returns, for an Obs or Actor, its state type
T Obs.StateUpdate	A function performing some action given the `newState` and the `oldState`.
T Obs.UnsubscribeFn	A generic function that is called to unsubscribe a subscription.
T Process	An asynchronous process to be executed at some time in the future.