-
Notifications
You must be signed in to change notification settings - Fork 308
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): reorganize overview content
- Loading branch information
1 parent
417d6e9
commit 593cd64
Showing
9 changed files
with
184 additions
and
149 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
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,6 @@ | ||
1. A TypeScript first interface for creating and sending requests including method names that reflect the schema. | ||
2. Type-safe request inputs (selection set, directives, etc.). | ||
3. Type-safe request outputs (results) inferred from the input. | ||
4. Automatic encoding and decoding of custom scalars. | ||
5. Type utilities to create TypeScript types based on types in the GraphQL schema. | ||
6. Runtime utilities to create reusable selection sets. |
This file was deleted.
Oops, something went wrong.
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,36 @@ | ||
# About Generation | ||
|
||
This guide is an overview of using generation. Individual features enabled by generation are discussed in other guides. There is a [practical tutorial in getting started](../overview/getting-started-generated.md). But if you're trying to build a mental model of what Graffle means when it talks about generation or generally want more detail on generation tools, then this guide is for you. | ||
|
||
## Benefits | ||
|
||
If you haven't read the [introduction](../overview/introduction.md), here is a recap of benefits from generation: | ||
|
||
<!--@include: @/_snippets/benefits.md--> | ||
|
||
## Architecture | ||
|
||
TODO | ||
|
||
## CLI | ||
|
||
Typically you will use the CLI to generate a client. After installing `graffle` you will have access to a CLI also named `graffle`. | ||
|
||
```bash | ||
pnpm add graffle | ||
pnpm graffle --schema '...' | ||
``` | ||
|
||
The CLI has built in help that you can use to learn about all its inputs. | ||
|
||
```bash | ||
pnpm graffle --help | ||
``` | ||
|
||
## API | ||
|
||
If you need to script graffle client generation then you can drop to the underlying Graffle generator API. It is largely one-to-one with the CLI. Use its JSDoc to learn about all its inputs. | ||
|
||
```ts | ||
import { generate } from 'graffle/generator' | ||
``` |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.