Typescript client GraphQL !graphql-client

This client is an abstraction of Apollo client to be used with typed methods.

Features

- Create a client
- Call mutation GraphQL
- Call query GraphQL
- Stringify a query or mutation without use client

Installation

This is a Node.js module.

Before installing, download and install Node.js. Node.js 14.0 or higher is required.

``bash
npm install ts-graphql-client
`
or
`bash
yarn add ts-graphql-client
`

How to use

`typescript
import { GraphQLClient } from 'ts-graphql-client'

type User = {
id: string;
name: string;
username: string;
email: string;
phone: string;
}

const client = new GraphQLClient('https://api.graphqlplaceholder.com/')

async function main() {
const users = await client
.query<{ data: User[] }, {}>(
'users',
{},
{
data: {
id: true,
name: true,
username: true,
email: true,
phone: true,
},
}
)
.then((res) => res.toJSON().data)
console.log(users)
}

main()
`

You can test it with stackblitz : ts-graphql-client-example

Details

$3

#### Quick start

`typescript
constructor(uri?: string, verbose?: boolean);
`

`typescript
new GraphQLClient('http://localhost:3000/graphql');
`

#### With options

`typescript
constructor(options?: ClientOptions, verbose?: boolean);
`

`typescript
new GraphQLClient({
uri: 'http://localhost:3000/graphql',
fetch: fetch as any,
});
`

More information about available options, read apollo-boost

$3

`typescript
query(name: string, parameters: ClientParameters, attribute: ClientAttribute>, callback: (data: ClientResult, err: ClientError) => void): void;
query(name: string, parameters: ClientParameters, attribute: ClientAttribute>): Promise>;
mutate(name: string, parameters: ClientParameters, attribute: ClientAttribute>, callback: (data: ClientResult, err: ClientError) => void): void;
mutate(name: string, parameters: ClientParameters, attribute: ClientAttribute>): Promise>;
`

$3

You can use queryToString` to parse your typed query without use client

$3

To generate types, we suggest to install graphql-code-generator

License

Property of traveljuice

MIT