]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
JS doc touchups. No code changes.
authorstephan <stephan@noemail.net>
Sat, 13 Jul 2024 15:21:35 +0000 (15:21 +0000)
committerstephan <stephan@noemail.net>
Sat, 13 Jul 2024 15:21:35 +0000 (15:21 +0000)
FossilOrigin-Name: a8e240495ff7e0cd38301ef2de215a7cc10fea832311bd19ca2592858ee4e6ff

ext/wasm/api/sqlite3-api-oo1.c-pp.js
manifest
manifest.uuid

index c07ecfcc26a4065456f0b0f8e13cb71fe048cf78..c579b5ddf70a91e09673ddd51d422432082073aa 100644 (file)
@@ -482,6 +482,10 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
      statement's preparation and when it is stepped may invalidate it.
 
      - `parameterCount`: the number of bindable parameters in the query.
+
+     As a general rule, most methods of this class will throw if
+     called on an instance which has been finalized. For brevity's
+     sake, the method docs do not all repeat this warning.
   */
   const Stmt = function(){
     if(BindTypes!==arguments[2]){
@@ -1686,12 +1690,11 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
          integer 0 or 1. It is not expected the distinction of binding
          doubles which have no fractional parts and integers is
          significant for the majority of clients due to sqlite3's data
-         typing model. If [BigInt] support is enabled then this
-         routine will bind BigInt values as 64-bit integers if they'll
-         fit in 64 bits. If that support disabled, it will store the
-         BigInt as an int32 or a double if it can do so without loss
-         of precision. If the BigInt is _too BigInt_ then it will
-         throw.
+         typing model. If BigInt support is enabled then this routine
+         will bind BigInt values as 64-bit integers if they'll fit in
+         64 bits. If that support disabled, it will store the BigInt
+         as an int32 or a double if it can do so without loss of
+         precision. If the BigInt is _too BigInt_ then it will throw.
 
        - Strings are bound as strings (use bindAsBlob() to force
          blob binding).
@@ -1797,9 +1800,9 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
     },
     /**
        Steps the statement one time. If the result indicates that a
-       row of data is available, a truthy value is returned.
-       If no row of data is available, a falsy
-       value is returned.  Throws on error.
+       row of data is available, a truthy value is returned.  If no
+       row of data is available, a falsy value is returned.  Throws on
+       error.
     */
     step: function(){
       affirmNotLockedByExec(this, 'step()');
@@ -1819,6 +1822,7 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
        Functions exactly like step() except that...
 
        1) On success, it calls this.reset() and returns this object.
+
        2) On error, it throws and does not call reset().
 
        This is intended to simplify constructs like:
@@ -1842,7 +1846,7 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
        throws.
 
        On success, it returns true if the step indicated that a row of
-       data was available, else it returns false.
+       data was available, else it returns a falsy value.
 
        This is intended to simplify use cases such as:
 
@@ -1860,6 +1864,7 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
         catch(e){/*ignored*/}
       }
     },
+
     /**
        Fetches the value from the given 0-based column index of
        the current data row, throwing if index is out of range.
@@ -1884,7 +1889,8 @@ globalThis.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
 
        If ndx is a plain object, this function behaves even
        differentlier: it assigns the properties of the object to
-       the values of their corresponding result columns.
+       the values of their corresponding result columns and returns
+       that object.
 
        Blobs are returned as Uint8Array instances.
 
index 2fcb0e24bb3b71c7529cb34aeca483ce370139f1..79eb0307ac9b575ea2b3273d31ed45b07048c585 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Add\sJS\sbindings\sfor\ssqlite3_stmt_busy()\sand\ssqlite3_stmt_explain().
-D 2024-07-13T14:07:47.157
+C JS\sdoc\stouchups.\sNo\scode\schanges.
+D 2024-07-13T15:21:35.136
 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1
 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea
 F LICENSE.md df5091916dbb40e6e9686186587125e1b2ff51f022cc334e886c19a0e9982724
@@ -612,7 +612,7 @@ F ext/wasm/api/post-js-header.js 04dc12c3edd666b64a1b4ef3b6690c88dcc653f26451fd4
 F ext/wasm/api/pre-js.c-pp.js ad906703f7429590f2fbf5e6498513bf727a1a4f0ebfa057afb08161d7511219
 F ext/wasm/api/sqlite3-api-cleanup.js d235ad237df6954145404305040991c72ef8b1881715d2a650dda7b3c2576d0e
 F ext/wasm/api/sqlite3-api-glue.c-pp.js b16c62712da2451dd978fecd6a552a8617a47daf58c4297a3d35af099b7738fd
-F ext/wasm/api/sqlite3-api-oo1.c-pp.js cec37fb3084635bf396a445848fb07361a68ae66dd473057326b22502a2ba67e
+F ext/wasm/api/sqlite3-api-oo1.c-pp.js aba93e986b141454af2be42f37dfcfaaa981434a3801af3e48f621b620e43061
 F ext/wasm/api/sqlite3-api-prologue.js b347a0c5350247f90174a0ad9b9e72a99a5f837f31f78f60fcdb829b2ca30b63
 F ext/wasm/api/sqlite3-api-worker1.c-pp.js 5cc22a3c0d52828cb32aad8691488719f47d27567e63e8bc8b832d74371c352d
 F ext/wasm/api/sqlite3-license-version-header.js 0c807a421f0187e778dc1078f10d2994b915123c1223fe752b60afdcd1263f89
@@ -2195,8 +2195,8 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93
 F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc
 F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e
 F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0
-P 6dcfcc7e1c0772b11aec750bb75899a5c8e452735ecf5028c001fbaa7aa6fda0
-R 02fee3213cf3b10ca74033e64620f4e9
+P b772edfb44143107d4993bde600d0f4c45184f29a4deee403105c64748c36523
+R ca0529b1c1f8382ec63447f4dfbe9ccc
 U stephan
-Z 595eefd86f8667df252210da82cc7b14
+Z 491715458459b2b75d340b7778b590f0
 # Remove this line to create a well-formed Fossil manifest.
index 1122aff01493e2a6dae974e6fb5d31f932f038c6..ceb23b6da2eb143a8310a2887c5f392f285c5845 100644 (file)
@@ -1 +1 @@
-b772edfb44143107d4993bde600d0f4c45184f29a4deee403105c64748c36523
+a8e240495ff7e0cd38301ef2de215a7cc10fea832311bd19ca2592858ee4e6ff