feat: Add Prettify utility for better type docs (#2)

fix #1
BearStudio · Jan 18, 2024 · 2dc75af · 2dc75af
1 parent bec168d
commit 2dc75af
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/packages/typed-mdx/src/index.ts b/packages/typed-mdx/src/index.ts
@@ -5,6 +5,10 @@ import matter from "gray-matter";
 
 const CONTENT_FOLDER = "src/content";
 
+type Prettify<T> = {
+  [K in keyof T]: T[K];
+} & {};
+
 function assertSchemaIsObject(
   schema: z.Schema
 ): asserts schema is z.AnyZodObject {
@@ -131,10 +135,10 @@ export function defineCollection<Z extends z.Schema>(options: {
   schema: Z;
   strict?: boolean;
 }): {
-  getAll: () => Promise<(z.infer<Z> & z.infer<typeof metadataSchema>)[]>;
+  getAll: () => Promise<(Prettify<z.infer<Z> & z.infer<typeof metadataSchema>>)[]>;
   getBySlug: (
     slug: string
-  ) => Promise<z.infer<Z> & z.infer<typeof metadataSchema>>;
+  ) => Promise<Prettify<z.infer<Z> & z.infer<typeof metadataSchema>>>;
   schema: Z;
 } {
   assertSchemaIsObject(options.schema);