prisma-cursorstream 0.1.1 → 0.3.0

package/README.md

@@ -23,6 +23,21 @@ import cursorStream from "prisma-cursorstream";
 const db = new PrismaClient().$extends(cursorStream);
 ```
 
+<details>
+<summary>Using CommonJS `require`?</summary>
+
+### CommonJS `require`
+
+```js
+const cursorStream = require("prisma-cursorstream").default;
+
+const db = new PrismaClient().$extends(cursorStream);
+```
+
+Refer to [#1](https://github.com/etabits/prisma-cursorstream/issues/1).
+
+</details>
+
 ## Usage
 
 ```js
@@ -43,19 +58,22 @@ for await (const post of stream) {
 
 ## Advanced API
 
-The following options provide additional controls over the streaming process.
+The following options (passed as a second argument) provide additional controls over the streaming process.
 
-- **Batch size**: The `take` property of the findMany arg is repurposed to specify how many rows are fetched each batch. Defaults to `100`
-- **Pre-fill size**: Since the streaming happens asynchronously, it may be useful to fetch more rows well before current batch is completely consumed. Use the `skip` property of the findMany arg which is repurposed to specify the internal `highWaterMark` of the `Readable` stream. Defaults to double the batch size (usually `200`).
+- **Batch size**: `batchSize` specifies how many rows are fetched each batch. Defaults to `100`
+- **Pre-fill size**: Since the streaming happens asynchronously, it may be useful to fetch more rows well before current batch is completely consumed. `prefill` specifies the internal `highWaterMark` of the `Readable` stream. Defaults to double the batch size (usually `200`).
 - **Batch transformation**: Sometimes you may need to pre-process the resulting rows in batches before they are consumed. This is where the `batchTransformer` comes in. If provided, it receives an array of the last fetched batch of rows, can operate on them asynchronously, and then return an array of transformed rows to be consumed instead. Types are properly handled.
 
 ```js
 const stream = db.post.cursorStream(
   {
-    take: 42, // batches of 42 posts at a time
-    skip: 69, // prefetch up to 69 posts
+    where: {
+      published: true,
+    },
   },
   {
+    batchSize: 42, // batches of 42 posts at a time
+    prefill: 69, // prefetch up to 69+ posts
     async batchTransformer(posts) {
       const translations = await translate(posts.map((p) => p.title));
       return posts.map((p, i) => ({

package/dist/index.d.ts

@@ -2,7 +2,9 @@ import { Prisma, PrismaClientExtends } from "@prisma/client/extension";
 import { DefaultArgs } from "@prisma/client/runtime/library";
 declare const _default: (client: any) => PrismaClientExtends<import("@prisma/client/runtime/library").InternalArgs<{}, {
     $allModels: {
-        cursorStream<T, A extends Prisma.Args<T, "findMany">, R extends Prisma.Result<T, A, "findMany">[number], C extends ((dataset: R[]) => Promise<unknown[]>) | undefined>(this: T, findManyArgs: A, { batchTransformer }?: {
+        cursorStream<T, A extends Prisma.Args<T, "findMany"> | undefined, R extends Prisma.Result<T, A, "findMany">[number], C extends ((dataset: R[]) => Promise<unknown[]>) | undefined>(this: T, findManyArgs: A, { batchSize, prefill, batchTransformer }?: {
+            batchSize?: number | undefined;
+            prefill?: number | undefined;
             batchTransformer?: C | undefined;
         }): Iterable<C extends Function ? Awaited<ReturnType<C>>[number] extends object ? Awaited<ReturnType<C>>[number] : R : R>;
     };

package/dist/index.js

@@ -6,10 +6,11 @@ exports.default = extension_1.Prisma.defineExtension((client) => {
     return client.$extends({
         model: {
             $allModels: {
-                cursorStream(findManyArgs, { batchTransformer } = {}) {
+                cursorStream(findManyArgs, { batchSize, prefill, batchTransformer } = {}) {
+                    findManyArgs = findManyArgs !== null && findManyArgs !== void 0 ? findManyArgs : {};
                     const context = extension_1.Prisma.getExtensionContext(this);
-                    const take = findManyArgs.take || 100;
-                    const highWaterMark = findManyArgs.skip || take * 2;
+                    const take = batchSize || 100;
+                    const highWaterMark = prefill || take * 2;
                     const cursorField = Object.keys(findManyArgs.cursor || {})[0] || "id";
                     if (findManyArgs.select && !findManyArgs.select[cursorField]) {
                         throw new Error(`Must select cursor field "${cursorField}"`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-cursorstream",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Prisma Stream Client Extension (Cursor-based Implementation)",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",