Add structural type#34
Closed
ForbesLindesay wants to merge 1 commit intodotansimha:masterfrom
Closed
Conversation
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.
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? |
Owner
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.