promptgun 0.8.6 → 0.9.0

package/README.md

@@ -63,14 +63,12 @@ await ai
       )
     )
   )
-  .onElement(restaurantStream => restaurantStream
-    .onCompleteAs(restaurant => {
-      // do stuff every time a restaurant has come through
-    })
-  )
+  .onElement(restaurantStream /* type safe */ => {
+    console.log(await restaurantStream)
+  })
 ```
-#### Streamed, "dumb"
-You can also simply get the partial data, "what has come in so far". The data is parsed for you, even as the underlying JSON that is received is incomplete.
+
+And iterating (not awaiting) any streamed json element simply gives the stream of accumulated partial data, "what has come in so far" as it comes in. The data is parsed for you, even as the underlying JSON that is received is incomplete.
 ```typescript
 const parsedPartialJsonStream = ai
   .chat('What are the top 5 restaurants in New York City?')
@@ -87,6 +85,25 @@ for await (const parsedPartialJson of parsedPartialJsonStream) {
 }
 ```
 
+### Image out
+```typescript
+await ai
+  .image('A black hole')
+  .imageSize('1024x1024') // optional
+  .model('gpt-image-1') // optional, default: gpt-image-1
+  .toFile('blackhole.png')
+```
+This writes the file, but it also returns a reference to that file:
+```typescript
+const file = await ai
+  .image('A black hole')
+  .toFile('blackhole.png')
+```
+You can also avoid writing a file altogether and get the byte array directly:
+```typescript
+const byteArray = await ai.image('A black hole')
+```
+
 ## Setup
 Before you do any prompts, do:
 ```typescript