@thi.ng/transducers-fsm 2.2.0 → 2.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-16T12:52:25Z
+- **Last updated**: 2022-12-22T21:47:08Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -26,7 +26,7 @@ updated with new features.**
 
 ## About
 
-Transducer-based Finite State Machine transformer
+Transducer-based Finite State Machine transformer. This is a support package for [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers).
 
 This package provides a single function, a general purpose [Finite State
 Machine](https://en.wikipedia.org/wiki/Finite-state_machine) transducer,

package/index.d.ts

@@ -11,29 +11,27 @@ export interface FSMOpts<T extends FSMState, A, B> {
     init: Fn0<T>;
 }
 /**
- * Finite State Machine transducer. Takes an FSM configuration object
- * and returns a transducer, which processes inputs using the provided
- * state handler functions, which in turn can return any number of
- * outputs per consumed input.
+ * Finite State Machine transducer. Takes an FSM configuration object and
+ * returns a transducer, which processes inputs using the provided state handler
+ * functions, which in turn can return any number of outputs per consumed input.
  *
- * Before processing the first input, the FSM state is initialized by
- * calling the user provided `init()` function, which MUST return a
- * state object with at least a `state` key, whose value is used for
- * dynamic (i.e. stateful) dispatch during input processing. This state
- * object is passed with each input value to the current state handler,
- * which is expected to mutate this object, e.g. to cause state changes
- * based on given inputs.
+ * Before processing the first input, the FSM state is initialized by calling
+ * the user provided `init()` function, which MUST return a state object with at
+ * least a `state` key, whose value is used for dynamic (i.e. stateful) dispatch
+ * during input processing. This state object is passed with each input value to
+ * the current state handler, which is expected to mutate this object, e.g. to
+ * cause state changes based on given inputs.
  *
- * If a state handler needs to "emit" results for downstream processing,
- * it can return an array of values. Any such values are passed on
- * (individually, not as array) to the next reducer in the chain. If a
- * state handler returns `null` or `undefined`, further downstream
- * processing of the current input is skipped.
+ * If a state handler needs to "emit" results for downstream processing, it can
+ * return an array of values. Any such values are passed on (individually, not
+ * as array) to the next reducer in the chain. If a state handler returns `null`
+ * or `undefined`, further downstream processing of the current input is
+ * skipped.
  *
- * Regardless of return value, if a state handler has caused a state
- * change to the configured `terminal` state, processing is terminated
- * (by calling {@link @thi.ng/transducers#ensureReduced}) and no further
- * inputs will be consumed.
+ * Regardless of return value, if a state handler has caused a state change to
+ * the configured `terminal` state, processing is terminated (by calling
+ * [`ensureReduced()`](https://docs.thi.ng/umbrella/transducers/functions/ensureReduced.html))
+ * and no further inputs will be consumed.
  *
  * @example
  * ```ts

package/index.js

@@ -1,29 +1,27 @@
 import { compR } from "@thi.ng/transducers/compr";
 import { ensureReduced, isReduced } from "@thi.ng/transducers/reduced";
 /**
- * Finite State Machine transducer. Takes an FSM configuration object
- * and returns a transducer, which processes inputs using the provided
- * state handler functions, which in turn can return any number of
- * outputs per consumed input.
+ * Finite State Machine transducer. Takes an FSM configuration object and
+ * returns a transducer, which processes inputs using the provided state handler
+ * functions, which in turn can return any number of outputs per consumed input.
  *
- * Before processing the first input, the FSM state is initialized by
- * calling the user provided `init()` function, which MUST return a
- * state object with at least a `state` key, whose value is used for
- * dynamic (i.e. stateful) dispatch during input processing. This state
- * object is passed with each input value to the current state handler,
- * which is expected to mutate this object, e.g. to cause state changes
- * based on given inputs.
+ * Before processing the first input, the FSM state is initialized by calling
+ * the user provided `init()` function, which MUST return a state object with at
+ * least a `state` key, whose value is used for dynamic (i.e. stateful) dispatch
+ * during input processing. This state object is passed with each input value to
+ * the current state handler, which is expected to mutate this object, e.g. to
+ * cause state changes based on given inputs.
  *
- * If a state handler needs to "emit" results for downstream processing,
- * it can return an array of values. Any such values are passed on
- * (individually, not as array) to the next reducer in the chain. If a
- * state handler returns `null` or `undefined`, further downstream
- * processing of the current input is skipped.
+ * If a state handler needs to "emit" results for downstream processing, it can
+ * return an array of values. Any such values are passed on (individually, not
+ * as array) to the next reducer in the chain. If a state handler returns `null`
+ * or `undefined`, further downstream processing of the current input is
+ * skipped.
  *
- * Regardless of return value, if a state handler has caused a state
- * change to the configured `terminal` state, processing is terminated
- * (by calling {@link @thi.ng/transducers#ensureReduced}) and no further
- * inputs will be consumed.
+ * Regardless of return value, if a state handler has caused a state change to
+ * the configured `terminal` state, processing is terminated (by calling
+ * [`ensureReduced()`](https://docs.thi.ng/umbrella/transducers/functions/ensureReduced.html))
+ * and no further inputs will be consumed.
  *
  * @example
  * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/transducers-fsm",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Transducer-based Finite State Machine transformer",
   "type": "module",
   "module": "./index.js",
@@ -34,12 +34,12 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.0",
-    "@thi.ng/transducers": "^8.3.26"
+    "@thi.ng/api": "^8.6.2",
+    "@thi.ng/transducers": "^8.3.28"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.7",
+    "@thi.ng/testament": "^0.3.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -74,5 +74,5 @@
     "status": "completed",
     "year": 2018
   },
-  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
+  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
 }