fix: enhanced documentation

Author: mrnkr

README.md

@@ -204,6 +204,15 @@ class MyAction extends PayloadAction<Payload, Meta, Error> {
 }
 ```
 
+Another, simpler, example is this class I took from the example. It's the action I dispatch when I want to complete a TODO item when I tap on one:
+
+```dart
+@immutable
+class CompleteTodo extends PayloadAction<Todo, dynamic, dynamic> {
+  const CompleteTodo(Todo todo) : super(payload: todo);
+}
+```
+
 ### `AsyncThunk` abstract class
 
 Again, no `createAsyncThunk` like in the original but an abstract class. This is an application of the template method design pattern so I'll allow you to specify your operation that returns a `Future` by overriding the `run` method and I'll take care of dispatching actions as the state of your `Future` evolves.

lib/src/action.dart

@@ -1,6 +1,23 @@
 import 'package:meta/meta.dart';
 
-/// Interface to use for your custom actions
+/// Base abstract class to make your custom actions more uniform
+/// 
+/// ### Examples
+/// 
+/// ```dart
+/// @immutable
+/// class CompleteTodo extends PayloadAction<Todo, void, void> {
+///   const CompleteTodo(Todo todo) : super(payload: todo);
+/// }
+/// ```
+/// 
+/// ```dart
+/// @immutable
+/// class Fulfilled<T, P, M> extends PayloadAction<P, Meta<M>, dynamic> {
+///   Fulfilled(P payload, M meta, String requestId) :
+///     super(payload: payload, meta: Meta(meta, requestId));
+/// }
+/// ```
 @immutable
 abstract class PayloadAction<Payload, Meta, Error> {
   final Payload payload;

lib/src/async_thunk.dart

@@ -17,49 +17,50 @@ class Meta<T> {
 
 /// Action that gets dispatched when an `AsyncThunk`
 /// starts being processed.
-/// 
+///
 /// Will come with the `payload` passed to the thunk
 /// within its `meta` member.
 @immutable
-class Pending<T, M> extends PayloadAction<dynamic, Meta<M>, dynamic> {
+class Pending<T, M> extends PayloadAction<void, Meta<M>, void> {
   Pending(M meta, String requestId) : super(meta: Meta(meta, requestId));
 }
 
 /// Action that gets dispatched when an `AsyncThunk`
 /// finishes successfully.
-/// 
+///
 /// Will have the `payload` that was initially passed
 /// to the thunk within its `meta` and the result
 /// of the operation in its `payload`.
 @immutable
-class Fulfilled<T, P, M> extends PayloadAction<P, Meta<M>, dynamic> {
-  Fulfilled(P payload, M meta, String requestId) : super(payload: payload, meta: Meta(meta, requestId));
+class Fulfilled<T, P, M> extends PayloadAction<P, Meta<M>, void> {
+  Fulfilled(P payload, M meta, String requestId)
+      : super(payload: payload, meta: Meta(meta, requestId));
 }
 
-
 /// Action that gets dispatched when an `AsyncThunk`
 /// finishes with an error.
-/// 
+///
 /// Will have the error that occurred in its `error`
 /// member and within its `meta` you'll find the
 /// `payload` that was initially passed to the thunk.
 @immutable
-class Rejected<T, M, E> extends PayloadAction<dynamic, Meta<M>, E> {
-  Rejected(M meta, E error, String requestId) : super(meta: Meta(meta, requestId), error: error);
+class Rejected<T, M, E> extends PayloadAction<void, Meta<M>, E> {
+  Rejected(M meta, E error, String requestId)
+      : super(meta: Meta(meta, requestId), error: error);
 }
 
 /// Abstraction to make thunks that just deal with a `Future`
 /// adhere to a standard.
-/// 
+///
 /// Before the `Future` starts processing this will dispatch a `Pending` action.
-/// 
+///
 /// After the `Future` resolves successfully this will dispatch a `Fulfilled` action.
-/// 
+///
 /// After the `Future` fails this will dispatch a `Rejected` action.
-/// 
-/// 
+///
+///
 /// ### Example
-/// 
+///
 /// ```dart
 /// @immutable
 /// class FetchTodos extends AsyncThunk<FetchTodos, AppState, void, List<Todo>> {
@@ -72,9 +73,10 @@ class Rejected<T, M, E> extends PayloadAction<dynamic, Meta<M>, E> {
 /// }
 /// ```
 @immutable
-abstract class AsyncThunk<Self, State, Payload, Result> implements CallableThunkAction<State> {
+abstract class AsyncThunk<Self, State, Payload, Result>
+    implements CallableThunkAction<State> {
   final Payload payload;
-  
+
   const AsyncThunk([this.payload]);
 
   Future<Result> run();

lib/src/create_reducer.dart

@@ -90,6 +90,31 @@ class _ActionReducerMapBuilder<State>
 
 /// Abstraction that allows to create a reducer without
 /// writing tons of `if` statements one after the other.
+/// 
+/// ### Examples
+/// 
+/// ```dart
+/// final todosReducer = createReducer<List<Todo>>(
+///     List.unmodifiable([]),
+///     (builder) => builder
+///         .addCase<Fulfilled<FetchTodos, List<Todo>, void>>(
+///             (state, action) => action.payload)
+///         .addCase<CompleteTodo>((state, action) => List.unmodifiable(state
+///             .map<Todo>((e) =>
+///                 e.id == action.payload.id ? e.copyWith(completed: true) : e)
+///             .toList())));
+/// ```
+/// 
+/// ```dart
+/// final statusReducer = createReducer(
+///     Map<String, String>.unmodifiable({}),
+///     (builder) => builder.addMatcher(
+///         (action) =>
+///             _isGeneric(action) &&
+///             ['Pending', 'Fulfilled', 'Rejected'].contains(_typeOfAction(action)),
+///         (state, action) =>
+///             Map.unmodifiable({...state, _typeOfThunk(action): _typeOfAction(action)})));
+/// ```
 Reducer<State> createReducer<State>(
     State initialState, BuilderCallback<State> builderCallback) {
   final builder = _ActionReducerMapBuilder<State>();

lib/src/nanoid.dart

@@ -3,7 +3,8 @@ import 'dart:math';
 // Borrowed from https://github.com/pd4d10/nanoid-dart/blob/master/lib/non_secure/generate.dart
 
 final _random = Random();
-final _alphabet = 'ModuleSymbhasOwnPr-0123456789ABCDEFGHNRVfgctiUvz_KqYTJkLxpZXIjQW';
+final _alphabet =
+    'ModuleSymbhasOwnPr-0123456789ABCDEFGHNRVfgctiUvz_KqYTJkLxpZXIjQW';
 
 /// An inlined copy of nanoid/nonsecure. Generates a non-cryptographically-secure
 /// random ID string. Automatically used by createAsyncThunk for request IDs, but

pubspec.yaml

@@ -13,7 +13,7 @@ dependencies:
   redux_thunk: ^0.3.0
   redux_dev_tools: ^0.5.2
   redux_remote_devtools: ^2.0.0
-  meta: ^1.2.2
+  meta: '>=1.1.8 <=1.2.2'
 
 dev_dependencies:
   test: ^1.3.0