Skip to content

Commit 12c1ac1

Browse files
Copilothotlong
andcommitted
fix: improve deprecation comments per code review feedback
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent b6653c8 commit 12c1ac1

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

packages/foundation/types/src/driver.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,9 +202,9 @@ export interface Driver {
202202

203203
// Transaction support
204204
beginTransaction?(): Promise<any>;
205-
/** @deprecated Use `commit` — aligned with @objectstack/spec DriverInterfaceSchema */
205+
/** @deprecated Use `commit` — aligned with @objectstack/spec DriverInterfaceSchema. Will be removed in v5.0. */
206206
commitTransaction?(transaction: any): Promise<void>;
207-
/** @deprecated Use `rollback` — aligned with @objectstack/spec DriverInterfaceSchema */
207+
/** @deprecated Use `rollback` — aligned with @objectstack/spec DriverInterfaceSchema. Will be removed in v5.0. */
208208
rollbackTransaction?(transaction: any): Promise<void>;
209209
/** Commit a transaction (spec-aligned name) */
210210
commit?(transaction: any): Promise<void>;
@@ -277,6 +277,8 @@ export interface Driver {
277277
/**
278278
* Get connection pool statistics.
279279
* Useful for monitoring database load.
280+
*
281+
* @returns Pool stats object, or undefined if pooling is not supported by the driver.
280282
*/
281283
getPoolStats?(): { total: number; idle: number; active: number; waiting: number } | undefined;
282284

0 commit comments

Comments
 (0)