fix: deprecate composeWithPagination method for TS 4.0 users; renam…

…e Opts typename
graphql-compose · Sep 14, 2020 · 3e83003 · 3e83003
1 parent 32ebd92
commit 3e83003
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/src/composeWithPagination.ts b/src/composeWithPagination.ts
@@ -1,13 +1,16 @@
 import { ObjectTypeComposer } from 'graphql-compose';
 import {
   preparePaginationResolver,
-  ComposeWithPaginationOpts,
+  PaginationResolverOpts,
   DEFAULT_RESOLVER_NAME,
 } from './pagination';
 
+/**
+ * @deprecated use `preparePaginationResolver()` instead
+ */
 export function composeWithPagination<TSource, TContext>(
   typeComposer: ObjectTypeComposer<TSource, TContext>,
-  opts: ComposeWithPaginationOpts
+  opts: PaginationResolverOpts
 ): ObjectTypeComposer<TSource, TContext> {
   if (!typeComposer || typeComposer.constructor.name !== 'ObjectTypeComposer') {
     throw new Error(

diff --git a/src/index.ts b/src/index.ts
@@ -4,7 +4,7 @@ import { composeWithPagination } from './composeWithPagination';
 export { composeWithPagination, preparePaginationResolver };
 
 export type {
-  ComposeWithPaginationOpts,
+  PaginationResolverOpts,
   PaginationTArgs,
   PaginationType,
   PaginationInfoType,

diff --git a/src/pagination.ts b/src/pagination.ts
@@ -9,7 +9,7 @@ import { preparePaginationTC } from './types';
 export const DEFAULT_RESOLVER_NAME = 'pagination';
 export const DEFAULT_PER_PAGE = 20;
 
-export type ComposeWithPaginationOpts = {
+export type PaginationResolverOpts = {
   findManyResolver: Resolver;
   countResolver: Resolver;
   name?: string;
@@ -40,7 +40,7 @@ export interface PaginationTArgs {
 
 export function preparePaginationResolver<TSource, TContext>(
   tc: ObjectTypeComposer<TSource, TContext>,
-  opts: ComposeWithPaginationOpts
+  opts: PaginationResolverOpts
 ): Resolver<TSource, TContext, PaginationTArgs> {
   if (!tc || tc.constructor.name !== 'ObjectTypeComposer') {
     throw new Error(