From 65f4b9db698ea006bae29c6d8478d7091cd45219 Mon Sep 17 00:00:00 2001 From: Keith Jackson Date: Fri, 17 Jan 2025 20:06:18 -0800 Subject: [PATCH] Add API doc note about statement finalization (#1310) * Add note about statement finalization * PR comment --- docs/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api.md b/docs/api.md index 29cf38d9..98dbbaba 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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: