Skip to content

Commit 3d79bd8

Browse files
aduh95sxa
aduh95
authored and
sxa
committed
doc: clarify filter option of sqlite.database.applyChangeset
Signed-off-by: Antoine du Hamel <[email protected]> PR-URL: #63515 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Edy Silva <[email protected]>
1 parent e07e7a3 commit 3d79bd8

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
@@ -800,8 +800,12 @@ added:
800800

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

0 commit comments

Comments
 (0)