Commit 2f20379
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>
Signed-off-by: Juan José Arboleda <soyjuanarbol@gmail.com>1 parent 0477830 commit 2f20379
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -366,8 +366,12 @@ added: v22.12.0 | |||
| 366 | 366 | ||
| 367 | 367 | * `changeset` {Uint8Array} A binary changeset or patchset. | |
| 368 | 368 | * `options` {Object} The configuration options for how the changes will be applied. | |
| 369 | - * `filter` {Function} Skip changes that, when targeted table name is supplied to this function, return a truthy value. | ||
| 370 | - By default, all changes are attempted. | ||
| 369 | + * `filter` {Function} for each table affected by at least | ||
| 370 | + one change in the changeset, the `filter` callback is invoked with the | ||
| 371 | + table name as the first argument. If the return value is falsy, then no | ||
| 372 | + attempt is made to apply any changes to the table. | ||
| 373 | + Otherwise, if the return value is truthy or no `filter` callback is provided, | ||
| 374 | + all changes related to the table are attempted. | ||
| 371 | 375 | * `onConflict` {Function} A function that determines how to handle conflicts. The function receives one argument, | |
| 372 | 376 | which can be one of the following values: | |
| 373 | 377 | ||
0 commit comments