fix(content): update type definition for QueryBuilder.fetch() (#825)

nuxt · Oct 21, 2021 · 4cc224e · 4cc224e
1 parent 1f4a5d2
commit 4cc224e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/packages/content/types/content.d.ts b/packages/content/types/content.d.ts
@@ -3,11 +3,22 @@ import type { QueryBuilder } from './query-builder'
 
 export type contentFunc = (...args: Array<string | Object>) => QueryBuilder;
 
-export interface IContentDocument extends Record<string, any> {
+export interface IContentDocumentBase extends Record<string, any> {
   dir: string;
   path: string;
   extension: '.md' | '.json' | '.yaml' | '.xml' | '.csv' | string;
   slug: string;
+  createdAt: Date | string;
+  updatedAt: Date | string;
+  body?: object;
+  toc?: {
+    id: string;
+    depth: number;
+    text: string;
+  }[];
+}
+
+export interface IContentDocument extends IContentDocumentBase {
   createdAt: Date;
   updatedAt: Date;
 }

diff --git a/packages/content/types/query-builder.d.ts b/packages/content/types/query-builder.d.ts
@@ -1,4 +1,5 @@
-import type { IContentDocument } from './content';
+import type { IContentDocumentBase } from "./content";
+
 interface QueryBuilderOptions {
   query: any;
   path: string;
@@ -7,6 +8,11 @@ interface QueryBuilderOptions {
   postprocess?: any[];
 }
 
+interface FetchReturn extends IContentDocumentBase {
+  createdAt: string;
+  updatedAt: string;
+}
+
 export class QueryBuilder {
   constructor(
     { query, path, init, text, postprocess }: QueryBuilderOptions,
@@ -77,6 +83,6 @@ export class QueryBuilder {
    * Collect data and apply process filters
    * @returns processed data
    */
-  fetch(): Promise<IContentDocument | IContentDocument[]>;
-  fetch<T>(): Promise<(T & IContentDocument) | (T & IContentDocument)[]>;
+  fetch(): Promise<FetchReturn | FetchReturn[]>;
+  fetch<T>(): Promise<(T & FetchReturn) | (T & FetchReturn)[]>;
 }