Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

graphql-parse-fields

1.2.0 • Public • Published

graphql-parse-fields Build Status js-standard-style

Parse fields from AST (GraphQLResolveInfo) into a JSON tree

Installation

npm i --save graphql-parse-fields

Usage

Example1: Parse GraphQL resolve info

  • @param {Object} info - graphql resolve info
  • @param {Boolean} [ignoreRoot] - default: true
  • @return {Object} fieldTree
var parseFields = require('graphql-parse-fields')
 
var GraphQLObjectType = //...
var UserType = //...
 
var queryType = new GraphQLObjectType({
  name: 'Query',
  fields: {
    user: {
      type: UserType,
      resolve: function (root, args, ctx, info) {
        var fields = parseFields(info)
        /*
        Fields parsed from query (at bottom of this example):
          note: since keepRoot was not passed, parseFields ignores the root key "user" for convenience
        {
          id: true,
          name: true,
          widgets: {
            edges {
              node {
                id: true
              }
            }
          }
        }
        */
 
       var fieldsWithRoot = parseFields(info, true) // keepRoot: true
       /*
        Fields parsed from query (at bottom of this example):
 
        {
          user {
            id: true,
            name: true,
            widgets: {
              edges {
                node {
                  id: true
                }
              }
            }
          }
        }
        */
      },
    }
  }
})
 
/*
Query:
 
query userQuery {
  user {
    id
    name
    widgets {
      edges {
        node {
          id
        }
      }
    }
  }
}
*/

Example2: Parse GraphQL ASTs

  • @param {Array} asts - ast array
  • @param {Object} [fragments] - optional fragment map
  • @param {Object} [fieldTree] - optional initial field tree
  • @return {Object} fieldTree
var ast = {
  "kind": "Field",
  "alias": null,
  "name": {
    "kind": "Name",
    "value": "user"
  },
  "selectionSet": {
    "kind": "SelectionSet",
    "selections": [
      {
        "kind": "Field",
        "name": {
          "kind": "Name",
          "value": "id"
        }
        selectionSet: null
        //...
      }
    ]
    //...
  }
  //...
}
parseAst(ast)
parseAst([ast])
/*
Both result in:
{
  user: {
    id: true
  }
}
*/

Changelog

CHANGELOG.md

License

MIT

Install

npm i graphql-parse-fields

DownloadsWeekly Downloads

416

Version

1.2.0

License

MIT

Last publish

Collaborators

  • avatar