Skip to content

Commit fad9ce1

Browse files
kjackson1998ArGeoph
authored andcommitted
Add API doc note about statement finalization (WiseLibs#1310)
* Add note about statement finalization * PR comment
1 parent 9b983ef commit fad9ce1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/api.md

+2
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,8 @@ An object representing a single SQL statement.
421421
- [Statement#bind()](#bindbindparameters---this)
422422
- [Properties](#properties-1)
423423

424+
> 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.
425+
424426
### .run([*...bindParameters*]) -> *object*
425427

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

0 commit comments

Comments
 (0)