From c19b73ea6db170578dfaf15f9eec46bfa283bdae Mon Sep 17 00:00:00 2001 From: Tom Elliott Date: Fri, 12 Jul 2024 18:08:25 +1200 Subject: [PATCH] update readme --- README.Rmd | 9 +++++---- README.html | 11 ++++++----- README.md | 9 +++++---- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/README.Rmd b/README.Rmd index 7437b8e..d3ddf05 100644 --- a/README.Rmd +++ b/README.Rmd @@ -70,7 +70,7 @@ export const app = { ), sample: z.function( z.tuple([z.character_vector(), z.integer()]), - z.promise(z.union([z.character(), z.character_vector()])) + z.promise(R.character()) ) }; ``` @@ -78,9 +78,10 @@ export const app = { which will generate the following types: ```typescript type App = { - add: (x: number, y: number) => Promise; - sample: (x: string[], n: number) => Promise; + add: (x: number, y: number) => Promise<{ data: number }>; + sample: (x: string[], n: number) => Promise<{ data: string | string[] }>; // or, if possible, even better: - sample: (x: string[], n: N) => Promise; + sample: (x: string[], n: N) => + Promise<{ data: N extends 1 ? string : string[] }>; }; ``` diff --git a/README.html b/README.html index b520161..5f737c3 100644 --- a/README.html +++ b/README.html @@ -647,16 +647,17 @@ body { ), sample: z.function( z.tuple([z.character_vector(), z.integer()]), - z.promise(z.union([z.character(), z.character_vector()])) + z.promise(R.character()) ) };

which will generate the following types:

type App = {
-  add: (x: number, y: number) => Promise<number>;
-  sample: (x: string[], n: number) => Promise<string | string[]>;
+  add: (x: number, y: number) => Promise<{ data: number }>;
+  sample: (x: string[], n: number) => Promise<{ data: string | string[] }>;
   // or, if possible, even better:
-  sample: <N extends number>(x: string[], n: N) => Promise<N extends 1 ? string : string[]>;
-};
+ sample: <N extends number>(x: string[], n: N) => + Promise<{ data: N extends 1 ? string : string[] }>; +}; diff --git a/README.md b/README.md index 9636347..5984d6c 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ export const app = { ), sample: z.function( z.tuple([z.character_vector(), z.integer()]), - z.promise(z.union([z.character(), z.character_vector()])) + z.promise(R.character()) ) }; ``` @@ -73,9 +73,10 @@ which will generate the following types: ``` typescript type App = { - add: (x: number, y: number) => Promise; - sample: (x: string[], n: number) => Promise; + add: (x: number, y: number) => Promise<{ data: number }>; + sample: (x: string[], n: number) => Promise<{ data: string | string[] }>; // or, if possible, even better: - sample: (x: string[], n: N) => Promise; + sample: (x: string[], n: N) => + Promise<{ data: N extends 1 ? string : string[] }>; }; ```