Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codemeasandwich/graphql-query-builder
a simple but powerful graphQL query builder
https://github.com/codemeasandwich/graphql-query-builder
api graphql query-builder
Last synced: 6 days ago
JSON representation
a simple but powerful graphQL query builder
- Host: GitHub
- URL: https://github.com/codemeasandwich/graphql-query-builder
- Owner: codemeasandwich
- License: mit
- Created: 2016-07-16T16:40:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-20T12:54:05.000Z (over 5 years ago)
- Last Synced: 2024-10-28T06:18:09.153Z (16 days ago)
- Topics: api, graphql, query-builder
- Language: JavaScript
- Size: 21.5 KB
- Stars: 98
- Watchers: 5
- Forks: 33
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# graphql-query-builder
a simple but powerful graphQL query builder
**info:**
[](https://badge.fury.io/js/graphql-query-builder)
[](http://doge.mit-license.org)
[](https://github.com/codemeasandwich/graphql-query-builder/pulls)
[](https://github.com/codemeasandwich/graphql-query-builder)
**tests:**
[](https://travis-ci.org/codemeasandwich/graphql-query-builder)
[](https://coveralls.io/github/codemeasandwich/graphql-query-builder?branch=master)
**quality:**
[](https://codeclimate.com/github/codemeasandwich/graphql-query-builder)
[](https://www.bithound.io/github/codemeasandwich/graphql-query-builder)
[](https://codeclimate.com/github/codemeasandwich/graphql-query-builder)
[](https://snyk.io/test/npm/graphql-query-builder)
### If this was helpful, [★ it on github](https://github.com/codemeasandwich/graphql-query-builder)
*tested on [**NodeJS**](https://nodejs.org) and [**Webpack**](https://webpack.github.io)*
## [Demo / Sandbox](https://tonicdev.com/codemeasandwich/57a0727c80254315001cb366) :thumbsup:
[](https://www.buymeacoffee.com/codemeasandwich)
# Install
`npm install graphql-query-builder`
# Api
``` js
const Query = require('graphql-query-builder');
```
### constructor
query/mutator you wish to use, and an alias or filter arguments.
| Argument (**one** to **two**) | Description
|--- |---
| String | the name of the query function
| * String / Object | (**optional**) This can be an `alias` or `filter` values
``` js
let profilePicture = new Query("profilePicture",{size : 50});
```
### setAlias
set an alias for this result.
| Argument | Description
|--- |---
| String | The alias for this result
``` js
profilePicture.setAlias("MyPic");
```
### filter
the parameters to run the query against.
| Argument | Description
|--- |---
| Object | An object mapping attribute to values
``` js
profilePicture.filter({ height : 200, width : 200});
```
### find
outlines the properties you wish to be returned from the query.
| Argument (**one** to **many**) | Description
|--- |---
| String or Object | representing each attribute you want Returned
| ... | *same as above*
``` js
profilePicture.find( { link : "uri"}, "width", "height");
```
### toString
return to the formatted query string
``` js
// A (ES6)
`${profilePicture}`;
// B
profilePicture+'';
// C
profilePicture.toString();
```
## run samples
``` bash
node example/simple.js
```
# Example
``` js
var Query = require('graphql-query-builder');
// example of nesting Querys
let profilePicture = new Query("profilePicture",{size : 50});
profilePicture.find( "uri", "width", "height");
let user = new Query("user",{id : 123});
user.find(["id", {"nickname":"name"}, "isViewerFriend", {"image":profilePicture}])
console.log(user)
/*
user( id:123 ) {
id,
nickname : name,
isViewerFriend,
image : profilePicture( size:50 ) {
uri,
width,
height
}
}
*/
// And another example
let MessageRequest = { type:"chat", message:"yoyo",
user:{
name:"bob",
screen:{
height:1080,
width:1920
}
},
friends:[
{id:1,name:"ann"},
{id:2,name:"tom"}
]
};
let MessageQuery = new Query("Message","myPost");
MessageQuery.filter(MessageRequest);
MessageQuery.find({ messageId : "id"}, {postedTime : "createTime" });
console.log(MessageQuery);
/*
myPost:Message( type:"chat",
message:"yoyo",
user:{name:"bob",screen:{height:1080,width:1920}},
friends:[{id:1,name:"ann"},{id:2,name:"tom"}])
{
messageId : id,
postedTime : createTime
}
*/
// Simple nesting
let user = new Query("user");
user.find([{"profilePicture":["uri", "width", "height"]}])
/*
user {
profilePicture {
uri,
width,
height
}
}
*/
// Simple nesting with rename
let user = new Query("user");
user.find([{"image":{"profilePicture":["uri", "width", "height"]}}])
/*
user {
image : profilePicture {
uri,
width,
height
}
}
*/
```