diff options
Diffstat (limited to 'ext/wasm/api/README.md')
| -rw-r--r-- | ext/wasm/api/README.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/ext/wasm/api/README.md b/ext/wasm/api/README.md index 9000697b2..6780c56ae 100644 --- a/ext/wasm/api/README.md +++ b/ext/wasm/api/README.md @@ -66,24 +66,33 @@ browser client: thread via the Worker message-passing interface. Like OO API #1, this is an optional component, offering one of any number of potential implementations for such an API. - - `sqlite3-worker1.js`\ + - `../sqlite3-worker1.js`\ Is not part of the amalgamated sources and is intended to be loaded by a client Worker thread. It loads the sqlite3 module and runs the Worker #1 API which is implemented in `sqlite3-api-worker1.js`. + - `../sqlite3-worker1-promiser.js`\ + Is likewise not part of the amalgamated sources and provides + a Promise-based interface into the Worker #1 API. This is + a far user-friendlier way to interface with databases running + in a Worker thread. - `sqlite3-api-opfs.js`\ - is an in-development/experimental sqlite3 VFS wrapper, the goal of - which being to use Google Chrome's Origin-Private FileSystem (OPFS) - storage layer to provide persistent storage for database files in a - browser. It is far from complete. + is an sqlite3 VFS implementation which supports Google Chrome's + Origin-Private FileSystem (OPFS) as a storage layer to provide + persistent storage for database files in a browser. It requires... + - `../sqlite3-opfs-async-proxy.js`\ + is the asynchronous backend part of the OPFS proxy. It speaks + directly to the (async) OPFS API and channels those results back + to its synchronous counterpart. This file, because it must be + started in its own Worker, is not part of the amalgamation. - `sqlite3-api-cleanup.js`\ the previous files temporarily create global objects in order to communicate their state to the files which follow them, and _this_ file connects any final components together and cleans up those globals. As of this writing, this code ensures that the previous - files leave no global symbols installed, and it moves the sqlite3 - namespace object into the in-scope Emscripten module. Abstracting - this for other WASM toolchains is TODO. + files leave no more than a single global symbol installed. When + adapting the API for non-Emscripten toolchains, this "should" + be the only file where changes are needed. - `post-js-footer.js`\ Emscripten-specific footer for the `--post-js` input. This closes off the lexical scope opened by `post-js-header.js`. |