Commit 3d79bd8
doc: clarify filter option of sqlite.database.applyChangeset
Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
PR-URL: #63515
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>1 parent e07e7a3 commit 3d79bd8
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -800,8 +800,12 @@ added: | |||
| 800 | 800 | ||
| 801 | 801 | * `changeset` {Uint8Array} A binary changeset or patchset. | |
| 802 | 802 | * `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. | ||
| 805 | 809 | * `onConflict` {Function} A function that determines how to handle conflicts. The function receives one argument, | |
| 806 | 810 | which can be one of the following values: | |
| 807 | 811 | ||
0 commit comments