Table of Contents

API Reference

These pages are generated from the XML documentation comments in the source, so they track the code exactly. Pick a namespace from the sidebar, or start with the types you will use most:

Type Namespace What it is
Stream<T> SodaFlow A stream of discrete events.
Cell<T> SodaFlow A value that changes at discrete points in time.
Behavior<T> SodaFlow A value defined at every point in time.
Transaction SodaFlow The atomic unit in which all updates happen.
Operational SodaFlow Escape hatches out of the pure model.

How the API is split across assemblies

SodaFlow.Core declares the types you hold — Stream<T>, Cell<T>, Behavior<T> and friends. SodaFlow layers the C#-facing surface on top of them, and almost all of it is extension methods: Map, Hold, Snapshot, Filter, Merge, Listen and the rest live in StreamExtensionMethods, CellExtensionMethods and BehaviorExtensionMethods rather than on the types themselves.

If you are looking for a method and cannot find it on the type, look in that type's ...ExtensionMethods class. See Which package do I install? for how the assemblies map onto NuGet packages.

F#

There is no generated reference for SodaFlow.FSharp — see F# and the API reference for why, and what the F# surface looks like in the meantime.