Skip to content

Updates to Effects documentation. #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2017
Merged

Updates to Effects documentation. #220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/api/effects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ string.
This is a perfect use case for an effect:

```javascript
// /src/effects/location.js

import url from 'url'
import {patch} from '../actions/query'
import {patchQuery} from '../actions/query'

class Location {

Expand Down Expand Up @@ -69,6 +71,8 @@ Returns an object mapping actions to methods on the effect. This is the
communication point between a effect and the rest of the system.

```javascript
// /src/effects/planets.js

import { addPlanet } from '../actions/planets'

class Planets {
Expand All @@ -84,5 +88,6 @@ class Planets {
}
}

repo.push(Actions.add, { name: 'earth' }) // this will add Earth
repo.addEffect(Planets)
repo.push(addPlanet, { name: 'earth' }) // this will add Earth
```