Skip to content

Update api.js to improve documentation #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 30, 2021
Merged

Update api.js to improve documentation #437

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a234d10
Update api.js to improve documentation
DavidPratten Jan 29, 2021
0f466d9
Fix formatting Issues 1
DavidPratten Jan 29, 2021
024dd65
Fix formatting Issues 2
DavidPratten Jan 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,13 @@ Module["onRuntimeInitialized"] = function onRuntimeInitialized() {
* You can't instantiate this class directly, you have to use a
* {@link Database} object in order to create a statement.
*
* **Warning**: When you close a database (using db.close()),
* all its statements are closed too and become unusable.
* **Warnings**
* 1. When you close a database (using db.close()), all
* its statements are closed too and become unusable.
* 1. After calling db.prepare() you must manually free the assigned memory
* by calling Statement.free(). Failure to do this will cause subsequent
* 'DROP TABLE ...' statements to fail with 'Uncaught Error: database table
* is locked'.
*
* Statements can't be created by the API user directly, only by
* Database::prepare
Expand Down