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

Add example to README #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add example to README #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ This is a [graphql-code-generator](https://graphql-code-generator.com/) plugin t

This plugin generates a [`possibleTypes` object](integration/graphql-types.ts) defining possible types which implement interfaces, [needed by Apollo](https://www.apollographql.com/docs/react/data/fragments/#defining-possibletypes-manually)

## Example
```sh
npm i @homebound/graphql-typescript-possible-types
```

**codegen.yml**
```yml
generates:
integration/graphql-types.ts:
plugins:
- node_modules/@homebound/graphql-typescript-possible-types
```

## Contributing

In order to develop changes for this package, follow these steps:
Expand Down