Skip to content

Add notes about ensure/debounceEvent not supporting async events #288

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add notes about ensure/debounceEvent not supporting async events #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
636ddd0
Add note about ensure not supporting async events
julienma Sep 20, 2018
e3dbf64
Add note about not supporting async events
julienma Sep 20, 2018
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
6 changes: 6 additions & 0 deletions docs/utils/debounce-event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,9 @@ const eventsMap = {

// provide the events map when creating your middleware or meta reducer...
```

### Note

The debounceEvent event does not currently support asynchronous events (see [comment](https://github.com/rangle/redux-beacon/issues/286#issuecomment-423023024)).

This means that it is not possible to use `debounceEvent` with [`ensure`](./ensure.md) for the same [`EventDefinition`](../api/event-definition.md) (or the other way around).
6 changes: 6 additions & 0 deletions docs/utils/ensure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,9 @@ const eventsMap = {
LOCATION_CHANGE: ensure(isValidPageView, pageview)
};
```

### Note

The ensure event does not currently support asynchronous events (see [comment](https://github.com/rangle/redux-beacon/issues/286#issuecomment-423023024)).

This means that it is not possible to use `ensure` with [`debounceEvent`](./debounce-event.md) for the same [`EventDefinition`](../api/event-definition.md) (or the other way around).