aboutsummaryrefslogtreecommitdiff
path: root/ext/wasm/api/sqlite3-api-oo1.js
diff options
context:
space:
mode:
authorstephan <stephan@noemail.net>2022-09-06 16:35:54 +0000
committerstephan <stephan@noemail.net>2022-09-06 16:35:54 +0000
commit09aa80d109eba3e3317a6d844673e6a0bc64ca06 (patch)
treee720eda3c84941c7af19efc38f78ab79f1f5aebd /ext/wasm/api/sqlite3-api-oo1.js
parentae1ed83831d9cb6026a15d30d43a309bf3fd758f (diff)
downloadsqlite-09aa80d109eba3e3317a6d844673e6a0bc64ca06.tar.gz
sqlite-09aa80d109eba3e3317a6d844673e6a0bc64ca06.zip
Minor internal doc clarifications.
FossilOrigin-Name: 09796cc2bfce7bc4ce11db9673d20737259e9928f0484660cba3a9751f7d01c5
Diffstat (limited to 'ext/wasm/api/sqlite3-api-oo1.js')
-rw-r--r--ext/wasm/api/sqlite3-api-oo1.js14
1 files changed, 9 insertions, 5 deletions
diff --git a/ext/wasm/api/sqlite3-api-oo1.js b/ext/wasm/api/sqlite3-api-oo1.js
index 3d24a7689..aafc04a2d 100644
--- a/ext/wasm/api/sqlite3-api-oo1.js
+++ b/ext/wasm/api/sqlite3-api-oo1.js
@@ -197,7 +197,7 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
Reminder: this will also fail after the statement is finalized
but the resulting error will be about an out-of-bounds column
- index.
+ index rather than a statement-is-finalized error.
*/
const affirmColIndex = function(stmt,ndx){
if((ndx !== (ndx|0)) || ndx<0 || ndx>=stmt.columnCount){
@@ -213,10 +213,14 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
{ sql: the SQL, opt: optionsObj, cbArg: function}
- cbArg is only set if the opt.callback is set, in which case
- it's a function which expects to be passed the current Stmt
- and returns the callback argument of the type indicated by
- the input arguments.
+ The opt object is a normalized copy of any passed to this
+ function. The sql will be converted to a string if it is provided
+ in one of the supported non-string formats.
+
+ cbArg is only set if the opt.callback or opt.resultRows are set,
+ in which case it's a function which expects to be passed the
+ current Stmt and returns the callback argument of the type
+ indicated by the input arguments.
*/
const parseExecArgs = function(args){
const out = Object.create(null);