feat (ai/core): add stopStream option to streamText transforms (#4344)

vercel · Jan 10, 2025 · 5510ee7 · 5510ee7
1 parent 084690d
commit 5510ee7
Show file tree

Hide file tree

Showing 8 changed files with 821 additions and 628 deletions.
diff --git a/.changeset/cyan-files-judge.md b/.changeset/cyan-files-judge.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+feat (ai/core): add stopStream option to streamText transforms
diff --git a/content/docs/03-ai-sdk-core/05-generating-text.mdx b/content/docs/03-ai-sdk-core/05-generating-text.mdx
@@ -236,7 +236,7 @@ all text to uppercase:
 ```ts
 const upperCaseTransform =
   <TOOLS extends Record<string, CoreTool>>() =>
-  (options: { tools: TOOLS }) =>
+  (options: { tools: TOOLS; stopStream: () => void }) =>
     new TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>({
       transform(chunk, controller) {
         controller.enqueue(

diff --git a/content/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx b/content/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx
@@ -471,10 +471,27 @@ To see `streamText` in action, check out [these examples](#examples).
     },
     {
       name: 'experimental_transform',
-      type: '({ tools: TOOLS }) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>',
+      type: '(options: TransformOptions) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>',
       isOptional: true,
       description:
         'Optional transformation that is applied to the stream. Tools are passed in for type inference.',
+      properties: [
+        {
+          type: 'TransformOptions',
+          parameters: [
+            {
+              name: 'stopStream',
+              type: '() => void',
+              description: 'A function that stops the stream.',
+            },
+            {
+              name: 'tools',
+              type: 'TOOLS',
+              description: 'The tools that are available.',
+            },
+          ],
+        },
+      ],
     },
     {
       name: 'experimental_providerMetadata',

diff --git a/packages/ai/core/generate-text/__snapshots__/stream-text.test.ts.snap b/packages/ai/core/generate-text/__snapshots__/stream-text.test.ts.snap
@@ -1858,7 +1858,7 @@ exports[`streamText > options.onFinish > should send correct information 1`] = `
 }
 `;
 
-exports[`streamText > options.transform > options.onFinish should receive transformed data 1`] = `
+exports[`streamText > options.transform > with base transformation > options.onFinish should receive transformed data 1`] = `
 {
   "experimental_providerMetadata": {
     "testProvider": {
@@ -2017,7 +2017,7 @@ exports[`streamText > options.transform > options.onFinish should receive transf
 }
 `;
 
-exports[`streamText > options.transform > options.onStepFinish should receive transformed data 1`] = `
+exports[`streamText > options.transform > with base transformation > options.onStepFinish should receive transformed data 1`] = `
 {
   "experimental_providerMetadata": {
     "testProvider": {
@@ -2098,7 +2098,7 @@ exports[`streamText > options.transform > options.onStepFinish should receive tr
 }
 `;
 
-exports[`streamText > options.transform > telemetry should record transformed data when enabled 1`] = `
+exports[`streamText > options.transform > with base transformation > telemetry should record transformed data when enabled 1`] = `
 [
   {
     "attributes": {