json-graphql-parser

0.1.9 • Public • Published

json-graphql-parser

A simple way to create and parse GraphQL query on node application

Building GraphQL query is just an API away.
No GraphQL knowledge is required.


GitHub watchers GitHub watchers GitHub watchers GitHub watchers

Table of Contents

Note V1 template will be deprecated soon. Use V2 instead.

Playground

Visit https://jgpp.koustov.com/

Install

    npm install json-graphql-parser axios url
    # or
    yarn add json-graphql-parser axios url

Usage

  1. Import ES6

    // ES6
    import { submit } from "json-graphql-parser";
    
    // ES5
    const { submit } = require("json-graphql-parser");
  2. Usage

    submit(query_config, url, additional_header);

Query Configuration

Basic Query

{
    display:    "[Optional | String]: Give a display name for the query",
    name:       "[Optional | String]: Query name",
    function:   "[Optional | String]: Target function name",
    write:      "[Optional | Boolean]: Whether it is a GraphQL query or mutation that you want to perform",
    return:     "[Required | String Array]: Array parameters to return"
}

Clause

{
    where: {
        clause {
            class:      "[Optional | String] Target class name",
            operator:   "[Optional | String] Operator type (or/and)",
            conditions: [{
                field:      "[Optional | String]: Field in question",
                operator:   "[Optional | String] Operator (eq | ne | in | ...)",
                value:      "[Optional | String] Value to match",
                class:      "[Optional | String] Target class name",
                clause:     "[Optional | Object] More recursive conditions"
            }],
        }
    },
}

Note: In conditions, you could either use field, operator and value properties or you can nest one level down using clause

Schema

Check the object schema here

Examples

A bunch of examples have been given under queries from an outstanding open-source application called Reactplay

Contribution 🍰

Feel free to create issue and make pull request

Refer Code of Conduct

Refer Contributing

License

MIT © Koustov

Package Sidebar

Install

npm i json-graphql-parser

Weekly Downloads

18

Version

0.1.9

License

MIT

Unpacked Size

46 kB

Total Files

14

Last publish

Collaborators

  • koustovm