promptgun 0.10.2 → 0.11.1

package/README.md

@@ -20,15 +20,16 @@ for await (const chunk of stream) {
 ```typescript
 const count /* type: number */ = await ai
   .chat('How many countries are in the EU')
-  .toNumber()
+  .getNumber()
 ```
-Promptgun will both tell the LLM what shape its output data should be, parse that data to JS types and –if you use Typescript– return the matching Typescript type.
+Promptgun will both tell the LLM what shape its output data should be, parse that data to JS types
+and correctly Typescript-type the output!
 
 You can do this for types of any complexity:
 ```typescript
 const restaurants /* type: {name: string, address?: string}[] */ = await ai
   .chat('Give 5 top restaurants in London')
-  .toArray(o => o
+  .getArray(o => o
     .object(o => o
       .hasString('name')
       .canHaveString('address')
@@ -40,7 +41,7 @@ You can also put instructions to the LLM in your type spec:
 ```typescript
 const restaurants /* type: {name: string, address: string}[] */ = await ai
   .chat('Give the top restaurant in London')
-  .toObject(o => o
+  .getObject(o => o
     .hasString('name')
     .hasString('description', 'A 50 character description')
   )
@@ -51,7 +52,7 @@ You can put callbacks on elements of the result data, which get called as they c
 ```typescript
 await ai
   .chat('Give 5 top restaurants in London')
-  .toArray(d => d
+  .getArray(d => d
     .object(obj => obj
       .hasString('name')
       .hasString('address')
@@ -66,7 +67,7 @@ And iterating (not awaiting) any streamed json element simply gives the stream o
 ```typescript
 const parsedPartialJsonStream = ai
   .chat('What are the top 5 restaurants in New York City?')
-  .toArray(o => o
+  .getArray(o => o
     .object(o => o
       .hasString('name')
       .hasString('address')

package/build/index.d.ts

@@ -862,13 +862,13 @@ export declare class BasicPrompt<PSArgs> implements AsyncGenerator<string>, Prom
     catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<string | TResult>;
     finally(onfinally?: (() => void) | null | undefined): Promise<string>;
     get [Symbol.toStringTag](): string;
-    to<Json extends AnyJson = AnyJson>(type: (value: EmptyTypeSpec<unknown>) => TypeSpec<Json>): JsonPrompt<PSArgs, Json>;
-    toBoolean(): JsonPrompt<PSArgs, boolean>;
-    toString(): JsonPrompt<PSArgs, string>;
-    toNumber(): JsonPrompt<PSArgs, number>;
-    toObject<T_obj extends {}>(properties: (arg: TypeMemberSpec<{}>) => TypeMemberSpec<T_obj>): JsonPrompt<PSArgs, T_obj>;
-    toArray<T_arr extends AnyJson>(element: (arg: EmptyTypeSpec<unknown>) => TypeSpec<T_arr>): JsonPrompt<PSArgs, T_arr[]>;
-    toAny(): JsonPrompt<PSArgs, AnyJson>;
+    get<Json extends AnyJson = AnyJson>(type: (value: EmptyTypeSpec<unknown>) => TypeSpec<Json>): JsonPrompt<PSArgs, Json>;
+    getBoolean(): JsonPrompt<PSArgs, boolean>;
+    getString(): JsonPrompt<PSArgs, string>;
+    getNumber(): JsonPrompt<PSArgs, number>;
+    getObject<T_obj extends {}>(properties: (arg: TypeMemberSpec<{}>) => TypeMemberSpec<T_obj>): JsonPrompt<PSArgs, T_obj>;
+    getArray<T_arr extends AnyJson>(element: (arg: EmptyTypeSpec<unknown>) => TypeSpec<T_arr>): JsonPrompt<PSArgs, T_arr[]>;
+    getAny(): JsonPrompt<PSArgs, AnyJson>;
     private getResponseAsString;
 }