Releases: KevinAst/astx-redux-util
Revised Documentation
NOTE: This is the First Production Release!
NOTE: This release is a documentation enhancement only. The API is NOT impacted in any way.
-
Our documentation has a new and improved look, using GitBook, integrated with JSDoc (for the API). I have not seen GitBook/JSDoc integrated before. If you are curious, read this article: Integrating GitBook with JSDoc to Document Your Open Source Project.
-
Removed unused dependency: lodash.isarray
Code Coverage Tooling
NOTE: This release is a tooling enhancement only. The API is NOT impacted in any way.
-
Introduce project code coverage, with badges for both grade and coverage.
-
Added pkgReview npm script that highlights any outdated installed packages and incorporate this into the check/prepublish scripts.
Extension Support with Logging Example
NOTE: This release is a documentation enhancement only. The API is NOT impacted in any way.
-
The Dev Guide was refined to include Extending astx-redux-util along with an extensive Logging Extension section, showing how
reducerHash()
can play a key roll in implementing a centralized reducer-based logging utility. -
A Most Excellent Example was streamlined, replacing the placeboReducer with an anonymous arrow function.
Parameter Validation
-
Parameter validation is now performed on all function calls. Invalid usage results in thrown exceptions. NOTE: The API is NOT impacted in any way.
-
SideBar: Starting in this release, a distribution tarball (
astx-redux-util_{ver}tar.gz
) is promoted in the GitHub Releases Page, which contains various executable bindings and documentation (should you wish to retain the docs locally). Please refer to the Distribution section (in the docs) for more details.
Added support for initialState
-
This release adds support for the
InitialState
parameter in each of the reducer composition utilities.This parameter optionally defines the fall-back state value used during the state initialization boot-strap process.
In general, redux expects your state to have concrete values (i.e. something other than
undefined
). This means that the reduction entry point to each state element should define a default. Keeping this in mind, theInitialState
parameter is optional, because some reducers are "by design" (when combined in a composition) intended to be mid-stream processors (i.e. NOT the reduction entry point).As is turns out, this simplifies the examples found in the astx-redux-util v0.1.0 release, in that NO app-supplied wrapper function is needed for the sole purpose of providing this initial value ... rather: the
InitialState
can be specified directly as a parameter to the astx-redux-util function.
Initial Release
- Holy Guacamole Batman! ... This commit has no parents!!