Skip to content

doc: clarify filter option of sqlite.database.applyChangeset #63515

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
aduh95 wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −2
Open

doc: clarify filter option of sqlite.database.applyChangeset #63515

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89c414a
doc: clarify `filter` option of `sqlite.database.applyChangeset`
aduh95 May 23, 2026
11e1575
fixup! doc: clarify `filter` option of `sqlite.database.applyChangeset`
aduh95 May 23, 2026
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
8 changes: 6 additions & 2 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,8 +820,12 @@ added:

* `changeset` {Uint8Array} A binary changeset or patchset.
* `options` {Object} The configuration options for how the changes will be applied.
* `filter` {Function} Skip changes that, when targeted table name is supplied to this function, return a truthy value.
By default, all changes are attempted.
* `filter` {Function} for each table affected by at least
one change in the changeset, the `filter` callback is invoked with the
table name as the first argument. If the return value is falsy, then no
attempt is made to apply any changes to the table.
Otherwise, if the return value is truthy or no `filter` callback is provided,
all changes related to the table are attempted.
* `onConflict` {Function} A function that determines how to handle conflicts. The function receives one argument,
which can be one of the following values:

Expand Down
Loading