Skip to content

Commit

Permalink
Add API doc note about statement finalization (#1310)
Browse files Browse the repository at this point in the history
* Add note about statement finalization

* PR comment
  • Loading branch information
kjackson1998 authored Jan 18, 2025
1 parent dde61cd commit 65f4b9d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,8 @@ An object representing a single SQL statement.
- [Statement#bind()](#bindbindparameters---this)
- [Properties](#properties-1)

> NOTE: Statements are [finalized](https://www.sqlite.org/c3ref/finalize.html) when garbage collected so there is no explicit API for it. Statements are also finalized when the associated database is closed.
### .run([*...bindParameters*]) -> *object*

Executes the prepared statement. When execution completes it returns an `info` object describing any changes made. The `info` object has two properties:
Expand Down

0 comments on commit 65f4b9d

Please sign in to comment.