Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meabed/gqlts
Type safe Graphql Query Builder
https://github.com/meabed/gqlts
axios graphql graphql-axios graphql-client graphql-client-typescript typed-graphql typescript
Last synced: 12 days ago
JSON representation
Type safe Graphql Query Builder
- Host: GitHub
- URL: https://github.com/meabed/gqlts
- Owner: meabed
- License: mit
- Created: 2022-05-03T04:21:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T16:08:20.000Z (13 days ago)
- Last Synced: 2024-10-29T16:08:31.337Z (13 days ago)
- Topics: axios, graphql, graphql-axios, graphql-client, graphql-client-typescript, typed-graphql, typescript
- Language: TypeScript
- Homepage: https://gqlts.vercel.app
- Size: 40.8 MB
- Stars: 25
- Watchers: 2
- Forks: 5
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Type safe Graphql query builder
Write Graphql queries with type validation and auto-completion with batteries included
[](https://github.com/meabed/gqlts/actions/workflows/ci.yml)
[](https://github.com/meabed/gqlts/actions/workflows/release.yml)
### @gqlts/cli
[](https://www.npmjs.com/package/@gqlts/cli/v/3.2.20)
[](https://www.npmjs.com/package/@gqlts/cli)
[](https://www.npmjs.com/package/@gqlts/cli)
[](https://unpkg.com/browse/@gqlts/cli@latest/)
### @gqlts/runtime
[](https://www.npmjs.com/package/@gqlts/runtime/v/3.2.20)
[](https://www.npmjs.com/package/@gqlts/runtime)
[](https://www.npmjs.com/package/@gqlts/runtime)
[](https://unpkg.com/browse/@gqlts/runtime@latest/)
> This package is forked version from [genql](https://github.com/remorses/genql/)
>
> It has been updated, fixed few bugs, actively adding features and updated dependencies and codebase to the latest packages
Read the [quick start guide](https://gqlts.vercel.app/docs) to generate a client locally
## **Features**
- Type completion
- Type validation
- Easily fetch all fields in a type
- Support subscription ( ws, graphql-ws, observable, etc )
- Built in file upload support
- Graphql Client built in
- Works with any client
- Works in node and the browser
- Built in Axios Client, and exported to extend with interceptors.
- Client Operation support for Axios configuration, such as headers, timeout, cancelToken, abortSignal, etc.
- Support batching queries
- Consistent response format { data, errors, extensions }
> Find more server-client examples in the [examples repo](https://github.com/meabed/graphql-examples)
> You will find multiple examples with different tools of building schema, query, mutation, websocket subscriptions and more.
## Example usage
First generate your client executing
```sh
npm i -D @gqlts/cli # cli to generate the client code
npm i @gqlts/runtime graphql # runtime dependencies
gqlts --schema ./schema.graphql --output ./generated
```
Then you can use your client as follows
```js
import { createClient, everything } from './generated'
const client = createClient()
client
.query({
countries: {
name: true,
code: true,
nestedField: {
...everything, // same as __scalar: true
},
},
})
.then(console.log)
```
The code above will fetch the graphql query below
```graphql
query {
countries {
name
code
nestedField {
scalarField1
scalarField2
}
}
}
```
---
## License
This is licensed under an MIT License. [See details](LICENSE)