kitten.sh
1---
2title: API Reference
3order: 4
4---
5
6Wonka, in essence, can be used to create sources, to transform sources with operators,
7and to consume values from a source with sinks.
8
9Looking at the type definition for what a sink is, it's just a function that can be
10called with a signal, which is either `Start`, `Push`, or `End`.
11Building on that, a source is just a function
12that takes a sink and calls it with signals over time. And lastly an operator is
13a function that accepts a source, alongside some options most of the time, and returns
14a new source.
15
16Wonka comes with plenty of sources, operators, and sinks built in. This section
17describes these and explains what they can be used for.
18
19- [Sources](./sources.md) — learn the Wonka source APIs
20- [Operators](./operators.md) — learn the Wonka operator APIs
21- [Sinks](./sinks.md) — learn the Wonka sink APIs