Skip to content

Commit

Permalink
docs: Document isError function (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
3af authored and JaKXz committed Nov 29, 2017
1 parent 272f2d5 commit 388ca8f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,21 @@ The optional `meta` property MAY be any type of value. It is intended for any ex

The module `flux-standard-action` is available on npm. It exports a few utility functions.

### `isFSA(action)`

```js
import { isFSA } from 'flux-standard-action';
```
### `isFSA(action)`

Returns true if `action` is FSA compliant.


### `isError(action)`

```js
import { isError } from 'flux-standard-action';
```
Returns true if `action` represents an error.

## Libraries

- [redux-actions](https://github.com/acdlite/redux-actions) - a set of helpers for creating and handling FSA actions in Redux.
Expand Down

0 comments on commit 388ca8f

Please sign in to comment.