rearch library

Classes

AsyncData<T>: The data variant for an AsyncValue.
AsyncError<T>: The error variant for an AsyncValue.
AsyncLoading<T>: The loading variant for an AsyncValue.
AsyncValue<T>: The current state of a Future or Stream, accessible from a synchronous context.
CapsuleContainer: Contains the data of Capsules. See the documentation for more.
CapsuleHandle: The handle given to a Capsule to build its data. See CapsuleReader and SideEffectRegistrar.
CapsuleReader: Provides a mechanism to read the current state of Capsules.
Disposable: Represents a disposable object.
MockableContainer: A CapsuleContainer that additionally allows you to mock capsules as a convenience when testing.
MockBuilder<T>: An intermediary created by MockableContainer.mock.
None<T>: An Option that does not have a value.
Option<T>: Represents an optional value of type T.
SideEffectApi: The api given to SideEffects to create their state.
SideEffectRegistrar: Provides a mechanism (register) to register side effects.
Some<T>: An Option that has a value.

AsyncValueConvenience on AsyncValue<T>: Convenience methods for handling AsyncValues.
BuiltinSideEffects on SideEffectRegistrar: A collection of builtin side effects.
CapsuleMapper on Capsule<T>: Provides the map convenience method on Capsules.
OptionConvenience on Option<T>: Convenience methods for handling Options.
ValueWrapperProperty on ValueWrapper<T>: Adds a value getter + setter on a ValueWrapper.
WarmUpCapsuleContainer on CapsuleContainer: Provides warmUp, a mechanism that waits for the specified capsules to be AsyncData.

capsule<T>(Capsule<T> cap) → Capsule<T>: Shorthand for a fully formed Capsule (Capsules are just Functions that consume CapsuleHandles).

Capsule<T> = T Function(CapsuleHandle): A blueprint for creating some data, given a CapsuleHandle. See the documentation for more.
CapsuleListener = void Function(CapsuleHandle): Capsule listeners are a mechanism to temporarily listen to changes to a set of Capsules. See CapsuleContainer.listen.
Mutation<T> = ({void Function() clear, void Function(Future<T> mutater) mutate, AsyncValue<T>? state}): Represents a mutation, with:
Reducer<State, Action> = State Function(State, Action): A reducer Function that consumes some State and Action and returns a new, transformed State.
SideEffect<T> = T Function(SideEffectApi): Defines what a SideEffect should look like (a Function that consumes a SideEffectApi and returns something). See the documentation for more.
SideEffectApiCallback = void Function(): A void Function() callback.
ValueWrapper<T> = (T Function(), void Function(T)): A wrapper around some value that is accessed via a getter + setter.