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

Allow to use Promises on discard function #53

Merged
merged 5 commits into from
Oct 24, 2017
Merged

Allow to use Promises on discard function #53

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f822740
Allow to use Promises on `discard` function
piranna Oct 18, 2017
f5c61e9
Fix linting errors
piranna Oct 18, 2017
42222ba
Added tests for returning a `Promise` object from `discard()` function
piranna Oct 23, 2017
03834a8
Documentation for returning a `Promise` object from `discard()` function
piranna Oct 23, 2017
771f093
Removed splitlines
piranna Oct 24, 2017
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
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ export type Config = {
detectNetwork: (callback: NetworkCallback) => void,
effect: (effect: any, action: OfflineAction) => Promise<*>,
retry: (action: OfflineAction, retries: number) => ?number,
discard: (error: any, action: OfflineAction, retries: number) => boolean,
discard: (error: any, action: OfflineAction, retries: number) => boolean|Promise<boolean>,
defaultCommit: { type: string },
defaultRollback: { type: string },
persist: (store: any) => any,
Expand Down Expand Up @@ -446,7 +446,14 @@ const config = {
}
```

The method receives the Error returned by the effect reconciler, the action being processed, and a number representing how many times the action has been retried. If the method returns `true`, the action will be discarded; `false`, and it will be retried. The full signature of the method is `(error: any, action: OfflineAction, retries: number) => boolean`.
The method receives the Error returned by the effect reconciler, the action
being processed, and a number representing how many times the action has been
retried. If the method returns `true`, the action will be discarded; `false`,
and it will be retried. The full signature of the method is `(error: any,
action: OfflineAction, retries: number) => boolean`. Alternatively, you can
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would update the signature and leave it at that.

Copy link
Author

Choose a reason for hiding this comment

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

What do you means?

return a Promise object that resolve to a boolean, allowing you to detect when
to discard asynchronously (for example, doing a request to a server to refresh a
token and try again).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Your editor appears to have inserted line breaks here. It doesn't affect the resulting document, but I'd prefer to leave them out, just for consistency.

Copy link
Author

Choose a reason for hiding this comment

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

I've added them myself, I'm used to 80 columns also on Markdown files. I don't like to scroll horizontally and I would change the full file instead to adjust it, but if you preffer to have it the old way I can be able to change it.


#### Change how network requests are retried

Expand Down