Skip to content

Commit 1ed2596

Browse files
committed
Update docs
1 parent dc49459 commit 1ed2596

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ console.log(action); // {type: 'SOMETHING_HAPPENED', payload: {foo: 'bar'}}
4141
### Async Action Creators
4242

4343
Async Action Creators are objects with properties `started`, `done` and
44-
`failed` whose values are action creators.
44+
`failed` whose values are action creators. There is a number of [Companion Packages](#companion-packages) that help with binding Async Action Creators to async processes.
4545

4646
```ts
4747
import actionCreatorFactory from 'typescript-fsa';
@@ -138,8 +138,11 @@ export const reducer = (state: State, action: Action): State => {
138138

139139
return state;
140140
};
141+
```
141142

143+
#### redux-observable
142144

145+
```ts
143146
// epic.ts
144147
import {Action} from 'redux';
145148
import {Observable} from 'rxjs';
@@ -162,7 +165,7 @@ export const epic = (actions$: Observable<Action>) =>
162165
});
163166
```
164167

165-
## Companion packages
168+
## Companion Packages
166169

167170
* [typescript-fsa-redux-saga](https://github.com/aikoven/typescript-fsa-redux-saga)
168171
* [typescript-fsa-redux-observable](https://github.com/m0a/typescript-fsa-redux-observable)
@@ -184,7 +187,7 @@ Creates Action Creator factory with optional prefix for action types.
184187
* `defaultIsError?: Predicate`: Function that detects whether action is error
185188
given the payload. Default is `payload => payload instanceof Error`.
186189

187-
### `ActionCreatorFactory<Payload>(type: string, commonMeta?: object, isError?: boolean): ActionCreator<Payload>`
190+
### `ActionCreatorFactory<Payload>#(type: string, commonMeta?: object, isError?: boolean): ActionCreator<Payload>`
188191

189192
Creates Action Creator that produces actions with given `type` and payload of type `Payload`.
190193

0 commit comments

Comments
 (0)