Wonka#

A fast push & pull stream library for Reason, loosely following the callbag spec

“There’s no earthly way of knowing
Which direction we are going
There’s no knowing where we’re rowing
Or which way the river’s flowing” － Willy Wonka

• What is Wonka
• Why it exists
• Installation
• Getting Started
• Documentation (In Progress)

What is Wonka#

Wonka is a library for lightweight observables and iterables loosely based on the callbag spec. It exposes a set of helpers to create and transform sources and output sinks, meaning it helps you to turn an event source or an iterable set of data into streams, and manipulate these streams.

Reason has been becoming increasingly popular, but it's missing a good pattern for streams that feels native to the language. The functional nature of callbags make them a perfect starting point to fix this, and to introduce a reactive programming pattern to a language that is well suited for it.

This library also attempts to support as many Reason/JS environments as possible, which makes the adoption of streams across multiple projects a lot easier. Hence Wonka is a library that aims to make complex streams of data easy to deal with.

Compatibility#

Wonka is not only compatible with Reason/Bucklescript, but out of the box with other environments as well.

• TypeScript
• JS/Flow
• Reason/OCaml Bucklescript
• Reason/OCaml bs-native
• Reason/OCaml Dune

In summary, it should work in any TypeScript/Flow/Reason/OCaml environment with full type safety.

Installation#

Install the library first: yarn add wonka or npm install --save wonka,

BuckleScript#

For Bucklescript you will also need to add wonka to bs-dependencies in your bsconfig.json file like so:

{
  "name": "<your name>",
  "version": "0.1.0",
  "sources": ["src"],
  "bsc-flags": ["-bs-super-errors"],
  "bs-dependencies": [
+    "wonka"
  ]
}

Documentation#

This is still a work-in-progress but will contain full information on the following across all supported languages:

• The API, i.e. a list of all helpers
• Examples
• Usage Guides & Recipes
• Developer Guides (How to write a source/operator/sink)
• Modified Callbag spec