Skip to content

Commit 74003f8

Browse files
committed
doc: improvements
1 parent a96cf00 commit 74003f8

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

doc/api/sqlite.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,13 @@ Creates and attaches a session to the database. This method is a wrapper around
167167

168168
* `changeset` {Uint8Array} A binary changeset or patchset.
169169
* `options` {Object} An optional object to configure how changes are applied.
170-
* `filter` {Function} Optional function that allows skipping changes based on the name of a table
171-
(passed as the first argument) based on a boolean returned. When not provided no changes are
172-
filtered, and all are changes are attempted.
173-
* `onConflict` {number} When provided, must be one of `SQLITE_CHANGESET_OMIT`,
174-
`SQLITE_CHANGESET_REPLACE` or `SQLITE_CHANGESET_ABORT`. Determines how conflicts are handled.
175-
Conflicting changes are either omitted, changes replace existing values or the
176-
call is aborted when the first conflicting change is encountered. Aborting on
177-
conflict is the default when no value is provided for this option.
170+
* `filter` {Function} Optional function. Skips changes when a truthy value is returned from it.
171+
Takes the name of the table that a change targets as first argument. When this option is not
172+
provided all changes are attempted.
173+
* `onConflict` {number} Determines how conflicts are handled. When provided, must be one of the values below:
174+
- `SQLITE_CHANGESET_OMIT`: conflicting changes are either omitted.
175+
- `SQLITE_CHANGESET_REPLACE`: conflicting changes replace existing values.
176+
- `SQLITE_CHANGESET_ABORT`: abort on conflict and roll back databsase (default).
178177
* Returns: {boolean} Whether the changeset was applied succesfully without being aborted.
179178

180179
An exception is thrown if the database is not

0 commit comments

Comments
 (0)