Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cuongndc9/hera
👩🏼💻 Simple and lightweight GraphQL client.
https://github.com/cuongndc9/hera
103cuong apollo apollo-client graphql graphql-client graphql-request hera hera-js
Last synced: 21 days ago
JSON representation
👩🏼💻 Simple and lightweight GraphQL client.
- Host: GitHub
- URL: https://github.com/cuongndc9/hera
- Owner: cuongndc9
- License: mit
- Created: 2019-11-12T15:46:00.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-31T10:37:28.000Z (almost 4 years ago)
- Last Synced: 2024-10-23T23:15:41.020Z (25 days ago)
- Topics: 103cuong, apollo, apollo-client, graphql, graphql-client, graphql-request, hera, hera-js
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/hera-js
- Size: 143 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# hera
👩🏼💻 Simple and lightweight GraphQL client.
[](#contributors)
[](https://travis-ci.com/103cuong/hera)
[](https://hitsofcode.com/view/github/103cuong/hera)
[](https://github.com/103cuong/hera/blob/master/LICENSE)
## 🧰 installation
```sh
yarn add hera-js
```
## 🌳 usage
```ts
import { hera } from 'hera-js';
const { data } = await hera({
options: {
url: 'https://example.com'
},
query: `
query {
user(id: $id) {
id
name
age
}
}
`,
variables: {
id: 1
}
});
```
**👻 passing parameters as objects**
```ts
const { data } = await hera({
options: {
url: 'https://example.com',
},
query: `
mutation {
createUser(info: $info) {
id
name
age
address
job
}
}
`,
variables: {
info: {
name: 'Cuong Tran',
age: 22,
address: 'Tam Ky - Sai Gon / Vietnam',
job: 'software engineer',
},
},
});
```
**🐛 error handling**
```ts
const { data, errors } = await hera({
options: {
url: 'https://example.com',
},
query: `
query {
user(id: $id) {
id
name
age
}
}
`,
variables: {
id: 1,
},
});
```
**🌏 global options**
> You can specify config defaults that will be applied to every request.
```ts
import { hera, globalOptions } from 'hera-js';
globalOptions.url = 'https://example.com';
// globalOptions.headers =
const { data } = await hera({
query: `
mutation {
createUser(info: $info) {
id
name
age
address
job
}
}
`,
variables: {
info: {
name: 'Cuong Tran',
age: 22,
address: 'Sai Gon / Vietnam',
job: 'software engineer',
},
},
});
```
**💩 enums**
```ts
const { data } = await hera({
query: `
mutation {
createUser(info: $info) {
id
name
age
address
job
sex
}
}
`,
variables: {
info: {
name: 'Cuong Tran',
age: 22,
address: 'Sai Gon / Vietnam',
job: 'software engineer',
sex: 'MALE',
},
},
options: {
enums: ['sex'],
},
});
```
## 🚀 API
```ts
interface Options {
url?: string;
headers?: any;
timeout?: number;
enums?: string[];
}
hera({
query: string;
variables?: any;
options?: Options;
}) : Promise<{ data: any; errors: any[] }>
```
### 📝 options
```ts
{
// `url` is the server URL that will be used for the request
url: '/example',
// `headers` are custom headers to be sent
headers: {
token: 'Fv0761DZcunUr0dKBc4oo5k55jJchwqu',
'Content-Type': 'application/json'
},
}
```
### 📒 query
> `query` is query or mutation in Graphql
**graphql's query**
```ts
query: `
query {
user(id: $id) {
id
name
age
}
}
`
```
**graphql's mutation**
```ts
query: `
mutation {
createUser(info: $info) {
id
name
age
address
job
}
}
`
```
### 💉 variables
> variables is used to pass values to query's variables
```ts
query: `
mutation {
createUser(info: $info) {
id
name
age
address
job
}
}
`,
variables: {
info: {
name: 'Cuong Tran',
age: 22,
address: 'Sai Gon / Vietnam',
job: 'software engineer',
},
}
```
## 🤝 contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## 📜 license
MIT © [Cuong Tran](https://github.com/103cuong)
