Skip to content

Commit 89c414a

Browse files
committed
doc: clarify filter option of sqlite.database.applyChangeset
Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 8d3245e commit 89c414a

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

doc/api/sqlite.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -820,8 +820,12 @@ added:
820820

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

0 commit comments

Comments
 (0)