\ No newline at end of file
diff --git a/docs/concepts.md b/docs/concepts.md
index c33dcea..e71f6a5 100644
--- a/docs/concepts.md
+++ b/docs/concepts.md
@@ -1,12 +1,32 @@
# Updux concepts
-## actions
+## Actions and action generators
-Updux internally uses the package `ts-action` to create action creator
-functions. Even if you don't use Typescript, I recommend that you use it,
-as it does what it does very well. But if you don't want to, no big deal.
-Updux will recognize a function as an action creator if it has a `type`
-property. So a homegrown creator could be as simple as:
+Updux assumes actions following the format
+
+```js
+{
+ type: 'theTypeName',
+ payload: {
+ ...
+ }
+}
+```
+
+The important part is having action parameters in the `payload` property. The
+actions can also have other properties, like `meta`. They are mostly ignored
+by Updux.
+
+
+Updux provides an action generator, but you can roll your own if you do wish.
+All it needs to do to be recognized as an action generator by Updux is
+
+1. To be a function returning an action (a plain object with at least a
+ `type` property).
+2. The function also needs to have a `type` property itself.
+
+
+For example, the following function would work:
```js
function action(type) {
@@ -14,7 +34,36 @@ function action(type) {
}
```
-## effects
+### Mutations
+
+The transformations typically
+done by a Redux's reducer are called 'mutations' in Updux. A mutation is a
+function with the following signature:
+
+```
+( payload, action ) => state => {
+ // ... stuff done here
+ return new_state;
+}
+```
+
+The inversion and chaining of parameters from the usual Redux reducer's
+signature is there to work with updeep's curried nature. The expansion of
+the usual `action` into `(payload, action)` is present because in most cases
+`payload` is what we're interested in. So why not make it easily available?
+
+### Leftover mutation
+
+A mutation associated to the special action `+` will match any action that haven't been
+explicitly dealt with with any other defined mutation.
+
+```
+todosUpdux.addMutation( '+', (payload,action) => state => {
+ console.log("hey, action has no mutation! ", action.type);
+});
+```
+
+## Effects
Updux effects are redux middlewares. I kept that format, and the
use of `next` mostly because I wanted to give myself a way to alter
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 6671f3d..67dd65d 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -44,142 +44,40 @@ todosDux.setAction( 'addTodo' );
todosDux.setAction( 'todoDone' );
```
-Now, there is a lot of ways to add actions to a Updux object.
-
-It can be defined when the object is created:
-
-```
-const todosUpdux = new Updux({
- actions: {
- add_todo,
- todo_done,
- }
-});
-```
-
-It can be done via the method `addAction`:
-
-```
-todosUpdux.addAction(add_todo);
-```
-
-Or it can be directly used in the definition of a mutation or effect, and will
-be automatically added to the Updux.
-
-```
-todosUpdux.addMutation( add_todo, todoMutation );
-```
-
-For TypeScript projects I recommend declaring the actions as part of the
-configuration passed to the constructors, as it makes them accessible to the class
-at compile-time, and allows Updux to auto-add them to its aggregated `actions` type.
-
-```
-const todosUpdux = new Updux({
- actions: {
- add_todo,
- }
-});
-
-todosUpdux.addAction(todo_done);
-
-// only `add_todo` is visible to the type
-type MyActions = typeof todosUpdux.actions;
-// { add_todo: Function }
-
-// but both actions are accessible at runtime
-const myAction = ( todosUpdux.actions as any).todo_done(1);
-```
-
### Accessing actions
Once an action is defined, its creator is accessible via the `actions` accessor.
+```js
+console.log( todosDux.actions.addTodo('write tutorial') ); // prints { type: 'addTodo', payload: 'write tutorial' }
```
-console.log( todosUpdux.actions.add_todo('write tutorial') );
-// { type: 'add_todo', payload: 'write tutorial' }
-```
-
-### What is an action?
-
-In this tutorial we use `ts-action` for all the work, but under the hood Updux defines actions via
-their creators, which are expected to be:
-
-1. Functions,
-2. returning a plain object of the format `{ type: string; payload?: unknown }`.
-3. with an additional property `type`, which is also the action type.
-
-For example, this is a perfectly cromulent action:
-
-```
-const add_todo = description => ({ type: 'add_todo', payload: description});
-add_todo.type = 'add_todo';
-```
-
-## Mutations
-
-Actions that don't do anything are not fun. The transformations typically
-done by a Redux's reducer are called 'mutations' in Updux. A mutation is a
-function with the following signature:
-
-```
-( payload, action ) => state => {
- // ... stuff done here
- return new_state;
-}
-```
-
-The inversion and chaining of parameters from the usual Redux reducer's
-signature is there to work with `updeep`'s curried nature. The expansion of
-the usual `action` into `(payload, action)` is present because in most cases
-`payload` is what we're interested in. So why not make it easily available?
### Adding a mutation
-As for the actions, a mutation can be defined as part of the Updux
+Like actions, a mutation can be defined as part of the Updux
init arguments:
-```
-const add_todo_mutation = description => ({next_id: id, todos}) => {
- return {
- next_id: 1 + id,
- todos: [...todos, { description, id, done: false }]
- }
-
-};
-
-const todosUpdux = new Updux({
- actions: { add_todo },
- mutations: [
- [ add_todo, add_todo_mutation ]
- ]
-});
-```
-
-or via the method `addMutation`:
-
-```
-todos.addMutation( add_todo, description => ({next_id: id, todos}) => {
- return {
- next_id: 1 + id,
- todos: [...todos, { description, id, done: false }]
+```js
+const todosDux = new Updux({
+ actions: {
+ addTodo: null
+ },
+ mutations: {
+ addTodo: description => ({next_id: id, todos}) => ({
+ next_id: 1 + id,
+ todos: [...todos, { description, id, done: false }]
+ })
}
});
```
-This time around, if the project is using TypeScript then the addition of
-mutations via `addMutation` is encouraged, as the method signature
-has visibility of the types of the action and state.
+or via the method `setMutation`:
-### Leftover mutation
-
-A mutation with the special action `*` will match any action that haven't been
-explicitly dealt with with any other defined mutation.
-
-```
-todosUpdux.addMutation( '*', (payload,action) => state => {
- console.log("hey, action has no mutation! ", action.type);
-});
+```js
+todosDux.setMutation( 'addTodo', description => ({next_id: id, todos}) => ({
+ next_id: 1 + id,
+ todos: [...todos, { description, id, done: false }]
+}));
```
## Effects
diff --git a/src/Updux.js b/src/Updux.js
index 007c3e7..07bb112 100644
--- a/src/Updux.js
+++ b/src/Updux.js
@@ -54,7 +54,7 @@ export class Updux {
this.#mutations = config.mutations ?? {};
Object.keys(this.#mutations)
- .filter((action) => action !== '*')
+ .filter((action) => action !== '+')
.filter((action) => !this.actions.hasOwnProperty(action))
.forEach((action) => {
throw new Error(`action '${action}' is not defined`);
diff --git a/src/buildUpreducer.js b/src/buildUpreducer.js
index 71ccada..6486e19 100644
--- a/src/buildUpreducer.js
+++ b/src/buildUpreducer.js
@@ -26,7 +26,7 @@ export function buildUpreducer(initial, mutations, subduxes = {}) {
}
}
- const a = mutations[action.type] || mutations['*'];
+ const a = mutations[action.type] || mutations['+'];
if (!a) return newState;
diff --git a/src/documentation.test.js b/src/documentation.test.js
index e6bf6c2..a62ed57 100644
--- a/src/documentation.test.js
+++ b/src/documentation.test.js
@@ -45,4 +45,6 @@ test('tutorial', async (t) => {
todosDux.setAction( 'addTodo' );
todosDux.setAction( 'todoDone' );
+ t.same( todosDux.actions.addTodo('write tutorial') , { type: 'addTodo', payload: 'write tutorial' });
+
})
diff --git a/src/index.js b/src/index.js
index fb808a9..e0135b8 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,2 +1,2 @@
export { Updux } from './Updux.js';
-
+export { action } from './actions.js';
diff --git a/src/mutations.test.js b/src/mutations.test.js
index 5979409..e7ce90c 100644
--- a/src/mutations.test.js
+++ b/src/mutations.test.js
@@ -27,7 +27,7 @@ test('override', async (t) => {
const dux = new Updux({
initial: { alpha: [] },
mutations: {
- '*': (payload, action) => (state) => ({
+ '+': (payload, action) => (state) => ({
...state,
alpha: [...state.alpha, action.type],
}),
diff --git a/types/index.d.ts b/types/index.d.ts
index f271176..9ac6d51 100644
--- a/types/index.d.ts
+++ b/types/index.d.ts
@@ -95,4 +95,12 @@ declare module 'updux' {
*/
setAction(actionType: string, payloadFunc?: Function);
}
+
+ /**
+ * Creates an action generator.
+ */
+ export function action(
+ actionType: string,
+ payloadFunction?: Function
+ ): ActionGenerator;
}
Creates an action generator.
+