docs: fix incomplete Records example (#2579)

colinhacks · Jul 31, 2023 · d870407 · d870407
1 parent ab8e717
commit d870407
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1525,6 +1525,12 @@ type NumberCache = z.infer<typeof NumberCache>;
 This is particularly useful for storing or caching items by ID.
 
 ```ts
+const userSchema = z.object({ name: z.string() });
+const userStoreSchema = z.record(userSchema);
+
+type UserStore = z.infer<typeof userStoreSchema>;
+// => type UserStore = { [ x: string ]: { name: string } }
+
 const userStore: UserStore = {};
 
 userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {

diff --git a/README_ZH.md b/README_ZH.md
@@ -845,6 +845,12 @@ type NumberCache = z.infer<typeof NumberCache>;
 这对于按 ID 存储或缓存项目特别有用。
 
 ```ts
+const userSchema = z.object({ name: z.string() });
+const userStoreSchema = z.record(userSchema);
+
+type UserStore = z.infer<typeof userStoreSchema>;
+// => type UserStore = { [ x: string ]: { name: string } }
+
 const userStore: UserStore = {};
 
 userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {

diff --git a/deno/lib/README.md b/deno/lib/README.md
@@ -1524,6 +1524,12 @@ type NumberCache = z.infer<typeof NumberCache>;
 This is particularly useful for storing or caching items by ID.
 
 ```ts
+const userSchema = z.object({ name: z.string() });
+const userStoreSchema = z.record(userSchema);
+
+type UserStore = z.infer<typeof userStoreSchema>;
+// => type UserStore = { [ x: string ]: { name: string } }
+
 const userStore: UserStore = {};
 
 userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {