.README/QUERY_METHODS.md

@@ -172,23 +172,44 @@ Example:
 
 ```ts
 await connection.stream(sql.typeAlias('foo')`SELECT foo`, (stream) => {
-  stream.on('data', (datum) => {
-    datum;
+  stream.on('data', (row) => {
+    row;
     // {
+    //   data: {
+    //     foo: 'bar'
+    //   },
     //   fields: [
     //     {
     //       name: 'foo',
     //       dataTypeId: 23,
     //     }
-    //   ],
-    //   row: {
-    //     foo: 'bar'
-    //   }
+    //   ]
     // }
   });
 });
 ```
 
+You can also using the [AsyncIterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator) interface:
+
+```ts
+await connection.stream(sql.typeAlias('foo')`SELECT foo`, async (stream) => {
+  for await (const row of stream) {
+    row;
+    // {
+    //   data: {
+    //     foo: 'bar'
+    //   },
+    //   fields: [
+    //     {
+    //       name: 'foo',
+    //       dataTypeId: 23,
+    //     }
+    //   ]
+    // }
+  }
+});
+```
+
 ### `transaction`
 
 `transaction` method is used wrap execution of queries in `START TRANSACTION` and `COMMIT` or `ROLLBACK`. `COMMIT` is called if the transaction handler returns a promise that resolves; `ROLLBACK` is called otherwise.

README.md

@@ -2469,23 +2469,44 @@ Example:
 
 ```ts
 await connection.stream(sql.typeAlias('foo')`SELECT foo`, (stream) => {
-  stream.on('data', (datum) => {
-    datum;
+  stream.on('data', (row) => {
+    row;
     // {
+    //   data: {
+    //     foo: 'bar'
+    //   },
     //   fields: [
     //     {
     //       name: 'foo',
     //       dataTypeId: 23,
     //     }
-    //   ],
-    //   row: {
-    //     foo: 'bar'
-    //   }
+    //   ]
     // }
   });
 });
 ```
 
+You can also using the [AsyncIterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator) interface:
+
+```ts
+await connection.stream(sql.typeAlias('foo')`SELECT foo`, async (stream) => {
+  for await (const row of stream) {
+    row;
+    // {
+    //   data: {
+    //     foo: 'bar'
+    //   },
+    //   fields: [
+    //     {
+    //       name: 'foo',
+    //       dataTypeId: 23,
+    //     }
+    //   ]
+    // }
+  }
+});
+```
+
 <a name="user-content-slonik-query-methods-transaction"></a>
 <a name="slonik-query-methods-transaction"></a>
 ### <code>transaction</code>

src/connectionMethods/query.ts

@@ -1,3 +1,4 @@
+import { type ExecutionRoutine } from '../routines/executeQuery';
 import { executeQuery } from '../routines/executeQuery';
 import {
   type Field,
@@ -7,6 +8,38 @@ import {
 } from '../types';
 import { type QueryResult as PgQueryResult } from 'pg';
 
+const executionRoutine: ExecutionRoutine = async (
+  finalConnection,
+  finalSql,
+  finalValues,
+) => {
+  const result: PgQueryResult & { notices?: Notice[] } =
+    await finalConnection.query(
+      finalSql,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      finalValues as any[],
+    );
+
+  const fields: Field[] = [];
+
+  if (result.fields) {
+    for (const field of result.fields) {
+      fields.push({
+        dataTypeId: field.dataTypeID,
+        name: field.name,
+      });
+    }
+  }
+
+  return {
+    command: result.command as QueryResult<unknown>['command'],
+    fields,
+    notices: result.notices ?? [],
+    rowCount: result.rowCount || 0,
+    rows: result.rows || [],
+  };
+};
+
 export const query: InternalQueryMethod = async (
   connectionLogger,
   connection,
@@ -20,32 +53,6 @@ export const query: InternalQueryMethod = async (
     clientConfiguration,
     slonikSql,
     inheritedQueryId,
-    async (finalConnection, finalSql, finalValues) => {
-      const result: PgQueryResult & { notices?: Notice[] } =
-        await finalConnection.query(
-          finalSql,
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          finalValues as any[],
-        );
-
-      const fields: Field[] = [];
-
-      if (result.fields) {
-        for (const field of result.fields) {
-          fields.push({
-            dataTypeId: field.dataTypeID,
-            name: field.name,
-          });
-        }
-      }
-
-      return {
-        command: result.command as QueryResult<unknown>['command'],
-        fields,
-        notices: result.notices ?? [],
-        rowCount: result.rowCount || 0,
-        rows: result.rows || [],
-      };
-    },
+    executionRoutine,
   );
 };