This project is part of the @thi.ng/umbrella monorepo.
Composable primitives for building declarative, transducer based Finite-State Machines & matchers for arbitrary data streams.
See the hiccup-markdown parser & example for a concrete use case.
ALPHA - bleeding edge / work-in-progress
Search or submit any issues for this package
This package will be merged with and update the existing @thi.ng/transducers-fsm package.
yarn add @thi.ng/fsm// ES module
<script type="module" src="https://unpkg.com/@thi.ng/fsm?module" crossorigin></script>
// UMD
<script src="https://unpkg.com/@thi.ng/fsm/lib/index.umd.js" crossorigin></script>Package sizes (gzipped, pre-treeshake): ESM: 1.38 KB / CJS: 1.49 KB / UMD: 1.51 KB
Several demos in this repo's /examples directory are using this package.
A selection:
| Screenshot | Description | Live demo | Source |
|---|---|---|---|
 |
Minimal Markdown to Hiccup to HTML parser / transformer | Demo | Source |
There're two key concepts provided by this package:
Matchers are composable functions which receive a single input value and attempt to match it to their configured criteria / patterns. Matchers also support optional user callbacks, which are executed when a match was made and are responsible for state transitions, state update and production of any result values.
alts()altsLit()always()lit()never()not()range()(plus multiple presets)repeat()seq()str()until()
See docs strings in /src folder for now.
The
fsm()
function is a Finite-state machine transducer / iterator with support
for single lookahead values. Takes an object of states and their
matchers, an arbitrary context object and an initial state ID.
The returned transducer consumes inputs of type T and produces results
of type R. The results are produced by callbacks of the given state
matchers. Each can produce any number of values. If a callback returns a
result wrapped w/ reduced(), the FSM causes early termination of the
overall transducer pipeline. Failed state callbacks too can produce
outputs, but will afterwards terminate the FSM.
An IllegalStateError will be thrown if a transition to an undefined
state ID occurs.
The optional update function will be invoked for each input prior to
executing the currently active state matcher. It is intended to update
the context object (e.g. to update input location info for generating
error messages).
If the optional src iterable is given, the function returns a
transforming iterator of the FSM results.
Karsten Schmidt
If this project contributes to an academic publication, please cite it as:
@misc{thing-fsm,
title = "@thi.ng/fsm",
author = "Karsten Schmidt",
note = "https://thi.ng/fsm",
year = 2018
}© 2018 - 2021 Karsten Schmidt // Apache Software License 2.0