Skip to content
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

Jump to bottom

Update README.md with requirements for the return value from afterInfinityModel #130

Merged
merged 2 commits into from
Mar 11, 2016
Merged

Update README.md with requirements for the return value from afterInfinityModel #130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fc5cd9
Update README.md with requirements for the return value from afterInf…
Jan 19, 2016
898e2b5
Update README.md to clarify that returning a promise from afterInfini…
Jan 19, 2016
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: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,15 @@ afterInfinityModel(posts) {
}
```

afterInfinityModel should return either a promise, ArrayProxy, or a
falsy value. The returned value, when not falsy, will take the place of the
resolved promise object and, if it is a promise, will hold execution until resolved.
In the case of a falsy value, the original promise result is used.

So relating this to the examples above... In the first example, afterInfinityModel
does not have an explicit return defined so the original posts promise result is used.
In the second example, the returned collection of authors is used.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thankyou @chbonser !!

The developer can also return a promise to afterInfinityModel - in which case it will hold execution before populating the model. I'd like to be sure we document that too! It's a big part of the feature

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Updating now.

### Event Hooks

The route mixin also provides following event hooks:
Expand Down