pgsql-test 2.0.5 → 2.0.6

package/README.md

@@ -79,6 +79,16 @@ afterAll(() => teardown());
 
 ## `getConnections()` Overview
 
+```ts
+import { getConnections } from 'pgsql-test';
+
+// Complete object destructuring
+const { pg, db, admin, teardown, manager } = await getConnections();
+
+// Most common pattern
+const { db, teardown } = await getConnections();
+```
+
 The `getConnections()` helper sets up a fresh PostgreSQL test database and returns a structured object with:
 
 * `pg`: a `PgTestClient` connected as the root or superuser — useful for administrative setup or introspection
@@ -97,6 +107,19 @@ The `PgTestClient` returned by `getConnections()` is a fully-featured wrapper ar
 
 ## `PgTestClient` API Overview
 
+```ts
+let pg: PgTestClient;
+let teardown: () => Promise<void>;
+
+beforeAll(async () => {
+  ({ pg, teardown } = await getConnections());
+});
+
+beforeEach(() => pg.beforeEach());
+afterEach(() => pg.afterEach());
+afterAll(() => teardown());
+```
+
 The `PgTestClient` returned by `getConnections()` wraps a `pg.Client` and provides convenient helpers for query execution, test isolation, and context switching.
 
 ### Common Methods

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgsql-test",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "PostgreSQL Testing in TypeScript",
   "main": "index.js",
@@ -42,5 +42,5 @@
     "pg": "^8.16.0",
     "pg-copy-streams": "^6.0.6"
   },
-  "gitHead": "5697261a8f6e252d38b02b806272a19c5cd7a578"
+  "gitHead": "9ca7885acaf53b419b6c589f739011e047dd6954"
 }