Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmedbhameed/graphty
GraphQL query producer for Angular framework.
https://github.com/ahmedbhameed/graphty
Last synced: 27 days ago
JSON representation
GraphQL query producer for Angular framework.
- Host: GitHub
- URL: https://github.com/ahmedbhameed/graphty
- Owner: AhmedBHameed
- License: mit
- Created: 2018-07-11T22:06:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-25T18:24:27.000Z (over 6 years ago)
- Last Synced: 2024-10-08T03:28:55.297Z (about 1 month ago)
- Language: JavaScript
- Size: 486 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Graphty
Angular 2+ Module to make it easer forming GraphQL queries.
# Installation
- Install module using:
```text
$ npm i graphty --save
```
- Import module to your *.module.ts
```typescript
...
import { GraphtyModule, GqlQueryInterface } from 'graphty';
@NgModule({
...
imports: [
...
GraphtyModule,
...
],
...
})
export class AppModule { }
```
- Two important methods for forming queries according to the type (Root query or mutation query).
- `root query` -> `stagnation(object: )` method.
- `mutation query` -> `mutation(object)` method.
- `combine queries` -> `combine(Array)` method V0.0.7.
- Inject `GraphtyService` inside you component class and feel free forming your graphql queries.
```typescript
import { GraphtyService } from 'graphty';
...
constructor(private graf: GraphtyService){}
getQuery(): GqlQueryInterface {
return this.graf.stagnation({
fun: {
name: 'getFoo', // required field and should be always string
args: {name: 'foo', limit: 15} // args is optional also it is auto detected when string inserted.
},
ret: ['id', 'foo_category', 'date'], // requested body can be nested by another query if with the same structure.
combine: [this.graf.stagnation({ // To combine more that one query in one request (in 0.0.7 removed)
fun: {
name: 'getAddress'
},
ret: ['country', 'town', 'street', 'house_number']
}]
})
}
mutateQuery(): GqlQueryInterface {
return this.graf.mutation({
fun: {
name: 'setNewFoo', // required field and should be always string
args: {name: 'foo', limit: 15} // args is optional also it is auto detected when string inserted.
},
ret: ['id', 'foo_category', 'date'], // requested body can be nested by another query if with the same structure.
combine: [this.graf.mutation({ // To combine more that one query in one request (in 0.0.7 removed)
fun: {
name: 'getAddress',
args: {id: 12}
},
ret: ['country', 'town', 'street', 'house_number']
}]
})
}
```
The previous example will produce this query bellow
```javascript
{ // result of getQuery() method
query: '{setNewFoo(name:"foo",limit:15){id,foo_category,date},getAddress{country,town,street,house_number}}'
}
{ // result of mutateQuery() method
query: 'mutation{setNewFoo(name:"foo",limit:15){id,foo_category,date},getAddress(id: 12){country,town,street,house_number}}'
}
```
Which you can pass them directly to the server who runs graphQL.
In version `0.0.7` property `combine` is seperated to reduce confusion which make it easier to form combined queries of graphQL. This method will reduce channel traffic between clients and server by combining two or more quries in one request. This should be with the respect of qurey type, since mutation should be send with `POST` and normal root query should send with `GET` they must not be mixed which is more reasonable. Mixing will throw error with a nice message ;)
```javascript
let GQLQ: GqlQueryInterface = this.graf.combine([
this.graf.stagnation({
fun: {
name: 'getUser',
args: { username: 'foo' }
},
ret: ['bar', this.graf.stagnation({ /** You can do nested object also as respond */
fun: {
name: 'ack'
},
ret: ['ok', 'message']
})
]
}),
this.graf.stagnation({
fun: {
name: 'getCategory',
args: {name: 'foo', limit: 15}
},
ret: ['id', 'work', 'skills']
})
]);
console.log(GQLQ); // Resault -> {query:`{getUser(username:"foo"){bar,ack{ok,message}},getCategory(name:"foo",limit:15){id,work,skills}}`}
```
# Versions history:
V0.0.9
- Fix string issue conversion with double quotation.
V0.0.8
- Fix module documentation only.
V0.0.7
- Combine method seperated from stangnation, mutation methods.
- also fix some bugs.
V0.0.4
- from now you can combine more than one query using combine property. Combining queries must be the same type either "Root queries" or "mutation queries" which sould be according to the method that called from.
stangnation -> combine queries should be all type of mutation.
mutation -> combine queries should be all type of mutation.
- Also few bugs fixed.
V0.0.3
- First module initialize