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.

Sign up for GitHub

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

docs: Type the graphql hoc in recipes #4340

Merged
merged 3 commits into from
Jan 22, 2019
Merged

docs: Type the graphql hoc in recipes #4340

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80044d8
docs: Type the graphql hoc in recipes
danilobuerger Jan 20, 2019
333e041
Merge branch 'master' into danilobuerger-patch-1
hwillson Jan 22, 2019
0151f68
Changelog updates
hwillson Jan 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/source/recipes/static-typing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Since the result of a query will be sent to the wrapped component as props, we w
```javascript
import React from "react";
import gql from "graphql-tag";
import { graphql } from "react-apollo";
import { ChildDataProps, graphql } from "react-apollo";

const HERO_QUERY = gql`
query GetCharacter($episode: Episode!) {
Expand Down Expand Up @@ -72,11 +72,13 @@ type Variables = {
episode: string;
};

type ChildProps = ChildDataProps<{}, Response, Variables>;

// Note that the first parameter here is an empty Object, which means we're
// not checking incoming props for type safety in this example. The next
// example (in the "Options" section) shows how the type safety of incoming
// props can be ensured.
const withCharacter = graphql<{}, Response, Variables>(HERO_QUERY, {
const withCharacter = graphql<{}, Response, Variables, ChildProps>(HERO_QUERY, {
options: () => ({
variables: { episode: "JEDI" }
})
Expand All @@ -96,7 +98,7 @@ Typically, variables to the query will be computed from the props of the wrapper
```javascript
import React from "react";
import gql from "graphql-tag";
import { graphql } from "react-apollo";
import { ChildDataProps, graphql } from "react-apollo";

const HERO_QUERY = gql`
query GetCharacter($episode: Episode!) {
Expand Down Expand Up @@ -131,7 +133,9 @@ type Variables = {
episode: string;
};

const withCharacter = graphql<InputProps, Response, Variables>(HERO_QUERY, {
type ChildProps = ChildDataProps<InputProps, Response, Variables>;

const withCharacter = graphql<InputProps, Response, Variables, ChildProps>(HERO_QUERY, {
options: ({ episode }) => ({
variables: { episode }
}),
Expand Down