Home

lbug-wasm

Welcome to the documentation of lbug-wasm, the WebAssembly build of Ladybug in-process property graph database management system. You are currently viewing the asynchronous JavaScript API documentation. This version dispatches all the function calls to the WebAssembly module to a Web Worker or Node.js worker thread to prevent blocking the main thread. However, this version may have a slight overhead due to the serialization and deserialization of the data required by the worker threads.

The documentation of each class can be found by clicking on the links in the sidebar.

For package-level functions, please refer to the documentation of the module lbug-wasm from the sidebar.

A summary of the files in this module is listed below:

connection.js

connection.js is the file for the Connection class. Connection is used to interact with a Database instance.
Source:

database.js

database.js is the file for the Database class. Database class is the main class of Lbug. It manages all database components.
Source:

dispatcher.js

dispatcher.js is the file for the internal Dispatcher class. Dispatcher is used to manage the worker thread for the wasm module.
Source:

fs.js

fs.js is the file for the FS class. FS is used to interact with the WebAssembly filesystem. It is an (incomplete) asynchronous wrapper around the Emscripten filesystem API.
Source:

index.js

index.js is the root file for the Lbug WebAssembly module. It exports the module's public interface.
Source:

lbug_wasm_worker.js

lbug_wasm_worker.js is the file for the worker thread that wraps around the synchronous WebAssembly module to create an asynchronous API.
Source:

prepared_statement.js

prepared_statement.js is the file for the PreparedStatement class. A prepared statement is a parameterized query which can avoid planning the same query for repeated execution.
Source:

query_result.js