feat(types): provide augmentations for only and without (#1200)

Co-authored-by: Ahad Birang <farnabaz@gmail.com> Co-authored-by: Yaël Guilloux <yael.guilloux@gmail.com>
nuxt · Jun 3, 2022 · 51a1620 · 51a1620
1 parent bda0cd0
commit 51a1620
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/src/runtime/query/query.ts b/src/runtime/query/query.ts
@@ -1,9 +1,10 @@
 import type { DatabaseFetcher, QueryBuilder, QueryBuilderParams, SortOptions } from '../types'
+import { ParsedContent } from '../types'
 import { ensureArray } from './match/utils'
 
 const arrayParams = ['sort', 'where', 'only', 'without']
 
-export const createQuery = <T>(
+export const createQuery = <T = ParsedContent>(
   fetcher: DatabaseFetcher<T>,
   queryParams?: Partial<QueryBuilderParams>
 ): QueryBuilder<T> => {
@@ -29,7 +30,7 @@ export const createQuery = <T>(
 
   const query: QueryBuilder<T> = {
     params: () => Object.freeze(params),
-    only: $set('only', ensureArray),
+    only: $set('only', ensureArray) as () => ReturnType<QueryBuilder<T>['only']>,
     without: $set('without', ensureArray),
     where: $set('where', (q: any) => [...ensureArray(params.where), q]),
     sort: $set('sort', (sort: SortOptions) => [...ensureArray(params.sort), ...ensureArray(sort)]),

diff --git a/src/runtime/types.d.ts b/src/runtime/types.d.ts
@@ -174,12 +174,14 @@ export interface QueryBuilder<T = ParsedContentMeta> {
   /**
    * Select a subset of fields
    */
-  only(keys: string | string[]): QueryBuilder<T>
+  only<K extends keyof T | string>(keys: K): QueryBuilder<Pick<T, K>>
+  only<K extends (keyof T | string)[]>(keys: K): QueryBuilder<Pick<T, K[number]>>
 
   /**
    * Remove a subset of fields
    */
-  without(keys: string | string[]): QueryBuilder<T>
+  without<K extends keyof T | string>(keys: K): QueryBuilder<Omit<T, K>>
+  without<K extends (keyof T | string)[]>(keys: K): QueryBuilder<Omit<T, K[number]>>
 
   /**
    * Sort results