action-u
Within the redux
framework, actions
are the
basic building blocks that facilitate application activity. Actions
follow a pre-defined convention that promote an action type and a
type-specific payload. Best practices prescribe that actions should
be created by action creators
(functions that return
actions).
While writing action creators
is a simple task, it is tedious and
potentially error prone. In addition, one has to define a set of
corresponding action types, and somehow promote these pairs
(creators/types) throughout your application. And then there is the
question of organization: How does one intuitively model actions that
are inner-related?
The action-u library addresses all of these areas. Not only does it
auto generate your action creators
, but it introduces organization to
your actions through a JSON-based ActionStruct
. This ActionStruct
is
a key aspect of action-u, it:
- implicitly defines your action types,
- instinctively groups related actions,
- and seamlessly promotes both
action creators
and types throughout your application.
At a Glance
Getting Started
... installation and accessConcepts ...
Basics
... learn the basics ofgenerateActions()
A Closer Look
... a valuable diagram detailing exactly what is going on!ActionStruct Shapes
... there is a lot of flexibility in how you organize yourActionStruct
Parameter Validation
... learn how to inject app-specific validationDefaulting Parameters
... learn how to apply default semantics to your action creator parametersThunk Action Creators
... learn how to integrate thunks into action-u
API Reference
... details the low-level functional APIOrganization ...
Action Promotion
... options to maintain and promote the actions within your applicationAction Documentation
... considerations for documenting your actions
Misc ...
Distribution
... where to find this utility (and a local copy of the docs)Why action-u?
... why was action-u created, and how does it compare to other utilitiesRevision History
... peruse various revisionsMIT License
... legal stuff