Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add structural type #34

Closed
wants to merge 1 commit into from

Conversation

ForbesLindesay
Copy link
Contributor

TypeScript is structurally typed, so the current implementation is pretty limited in what it will enforce. e.g. https://github.com/dotansimha/graphql-typed-document-node/blob/master/examples/apollo-client-3/index.ts does not currently enforce the type of the variables.

By adding this optional property, even though no code will ever implement this method, it forces TypeScript to actually verify the types.

TypeScript is structurally typed, so the current implementation is pretty limited in what it will enforce. e.g. https://github.com/dotansimha/graphql-typed-document-node/blob/master/examples/apollo-client-3/index.ts does not currently enforce the type of the variables.

By adding this optional property, even though no code will ever implement this method, it forces TypeScript to actually verify the types.
@dotansimha
Copy link
Owner

You are right, thanks @ForbesLindesay !

Maybe it can be something like that instead?

export interface TypedDocumentNode<Result = { [key: string]: any }, Variables = { [key: string]: any }> extends DocumentNode {
  __resultType?: Result;
  __variablesType?: Variables;
}

It will make it a bit more clear, what do you think?

@dotansimha
Copy link
Owner

@dotansimha dotansimha closed this Aug 17, 2020
@ForbesLindesay
Copy link
Contributor Author

Sorry I didn't respond to this in time. Unfortunately your code, although arguably more readable, does not enforce the correct types. I have opened #38 with a fix and a more detailed explanation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants