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

Fix default value of eventReduce option in documentation #4614

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Fix default value of eventReduce option in documentation #4614

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
4 changes: 2 additions & 2 deletions docs-src/rx-database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const db = await createRxDatabase({
storage: getRxStorageDexie(), // <- RxStorage
password: 'myPassword', // <- password (optional)
multiInstance: true, // <- multiInstance (optional, default: true)
eventReduce: true // <- eventReduce (optional, default: true)
eventReduce: true, // <- eventReduce (optional, default: false)
cleanupPolicy: {} // <- custom cleanup policy (optional)
});
```
Expand Down Expand Up @@ -71,7 +71,7 @@ When you create more than one instance of the same database in a single javascri
`multiInstance` should be set to `false` when you have single-instances like a single Node.js-process, a react-native-app, a cordova-app or a single-window electron app which can decrease the startup time because no instance coordination has to be done.

### eventReduce
`(optional=true)`
`(optional=false)`

One big benefit of having a realtime database is that big performance optimizations can be done when the database knows a query is observed and the updated results are needed continuously. RxDB uses the [EventReduce Algorithm](https://github.com/pubkey/event-reduce) to optimize observer or recurring queries.

Expand Down