Merge pull request #38 from ForbesLindesay/patch-2

fix: ensure variance of types matches how values are used
dotansimha · Sep 24, 2020 · e3ac5b0 · e3ac5b0
2 parents c35b2e8 + 6ee77c2
commit e3ac5b0
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,8 +1,12 @@
 import { DocumentNode } from 'graphql';
 
 export interface TypedDocumentNode<Result = { [key: string]: any }, Variables = { [key: string]: any }> extends DocumentNode {
- __resultType?: Result;
- __variablesType?: Variables;
+ /**
+ * This type is used to ensure that the variables you pass in to the query are assignable to Variables
+ * and that the Result is assignable to whatever you pass your result to. The method is never actually
+ * implemented, but the type is valid because we list it as optional
+ */
+ __apiType?: (variables: Variables) => Result;
 }
 
 /**