-
-
Notifications
You must be signed in to change notification settings - Fork 26.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document .graphql and .gql file loading with graphql.macro (#5481)
- Loading branch information
Showing
3 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: loading-graphql-files | ||
title: Loading .graphql Files | ||
sidebar_label: Loading .graphql Files | ||
--- | ||
|
||
To load `.gql` and `.graphql` files, first install the [`graphql.macro`](https://www.npmjs.com/package/graphql.macro) package by running: | ||
|
||
```sh | ||
npm install --save graphql.macro | ||
``` | ||
|
||
Alternatively you may use `yarn`: | ||
|
||
```sh | ||
yarn add graphql.macro | ||
``` | ||
|
||
Then, whenever you want to load `.gql` or `.graphql` files, import the `loader` from the macro package: | ||
|
||
```js | ||
import { loader } from 'graphql.macro'; | ||
|
||
const query = loader('./foo.graphql'); | ||
``` | ||
|
||
And your results get automatically inlined! This means that if the file above, `foo.graphql`, contains the following: | ||
|
||
```graphql | ||
gql` | ||
query { | ||
hello { | ||
world | ||
} | ||
} | ||
`; | ||
``` | ||
|
||
The previous example turns into: | ||
|
||
```javascript | ||
const query = { | ||
'kind': 'Document', | ||
'definitions': [{ | ||
... | ||
}], | ||
'loc': { | ||
... | ||
'source': { | ||
'body': '\\\\n query {\\\\n hello {\\\\n world\\\\n }\\\\n }\\\\n', | ||
'name': 'GraphQL request', | ||
... | ||
} | ||
} | ||
}; | ||
``` | ||
|
||
You can also use the `gql` template tag the same way you would use the non-macro version from `graphql-tag` package with the added benefit of inlined parsing results. | ||
|
||
```js | ||
import { gql } from 'graphql.macro'; | ||
|
||
const query = gql` | ||
query User { | ||
user(id: 5) { | ||
lastName | ||
...UserEntry1 | ||
} | ||
} | ||
`; | ||
``` |
This file contains 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
This file contains 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