diff options
author | stephan <stephan@noemail.net> | 2022-11-23 21:09:51 +0000 |
---|---|---|
committer | stephan <stephan@noemail.net> | 2022-11-23 21:09:51 +0000 |
commit | f1ce4f40c7a01fd272662ab42d24b1f3ba747069 (patch) | |
tree | 84374f83550d4f3265d8833db86a83d69193981c /ext/wasm/api/sqlite3-api-prologue.js | |
parent | 875db41afca4447f00ecbb554e5268017a4c8b87 (diff) | |
download | sqlite-f1ce4f40c7a01fd272662ab42d24b1f3ba747069.tar.gz sqlite-f1ce4f40c7a01fd272662ab42d24b1f3ba747069.zip |
Minor JS doc updates.
FossilOrigin-Name: 27efd63ad7fb3bf8d0d07f2c9f48652c8cacc4e697c229c8085120a8e6b50a39
Diffstat (limited to 'ext/wasm/api/sqlite3-api-prologue.js')
-rw-r--r-- | ext/wasm/api/sqlite3-api-prologue.js | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/ext/wasm/api/sqlite3-api-prologue.js b/ext/wasm/api/sqlite3-api-prologue.js index f9ad5b512..1cddc8eaf 100644 --- a/ext/wasm/api/sqlite3-api-prologue.js +++ b/ext/wasm/api/sqlite3-api-prologue.js @@ -1307,12 +1307,16 @@ self.sqlite3ApiBootstrap = function sqlite3ApiBootstrap( }; /** - Serializes the given `sqlite3*` pointer to a Uint8Array, as per - sqlite3_serialize(). On success it returns a Uint8Array. On - error it throws with a description of the problem. + A convenience wrapper around sqlite3_serialize() which serializes + the given `sqlite3*` pointer to a Uint8Array. - schema is the schema to serialize. It may be a WASM C-string - pointer or a JS string. If it is falsy, it defaults to "main". + On success it returns a Uint8Array. If the schema is empty, an + empty array is returned. + + `schema` is the schema to serialize. It may be a WASM C-string + pointer or a JS string. If it is falsy, it defaults to `"main"`. + + On error it throws with a description of the problem. */ capi.sqlite3_js_db_export = function(pDb, schema=0){ if(!pDb) toss3('Invalid sqlite3* argument.'); |