Machine

machineAtom

function machineAtom(
	machine: IMachine,
	opts?: {
		atomFactory?: (init: State) => WritableAtom
		listener?: (event: Message, get: Getter, set: Setter) => void
	},
)

Creates an atom representing a given machine.

Optional atomFactory function creates an atom which will store the core (non-derived) part of the atom. This is useful for persistence or transport of the machine. Since only the core is stored, you don't have to worry about derived state being unserializable.

listener is a function being called to interpret messages send inside the machine. It can use get and set to read from and write to atoms.

useMachineEffects

function useMachineEffects(
	transformed: Transformed,
	send: (event: Event) => void,
	interpreter: Interpreter<Event, Transformed>,
)

disabledEventAtom

export function disabledEventAtom(
	machineAtom: WritableAtom,
	event: { [Key]: (params, send: (e: Event)) => (() => void) | void },
): Atom

Reading the atom will return true if sending the event has any effect on the machine. Writing to the atom (without parameters) will send the event.

This is useful for binding an event with a button-like element, hence the name.

valueEventAtom

export function valueEventAtom(
	machineAtom: WritableAtom,
	select: (state: State) => Value,
	put: (value: Value, send: (event: Event) => void) => void,
): Atom

When some event updates a specific part of a machine state, you can create a WritableAtom focusing on that part of the machine. (And you can further manipulate that state with focusAtom).