graphql-list-fields
v2.0.4
Published
Get a list of fields while resolving a GraphQL query
Downloads
151,380
Maintainers
Readme
graphql-list-fields
When implementing a GraphQL server, it can be useful to know the list of fields being queried on a given type. This module takes a GraphQLResolveInfo object and returns a list of fields.
Supported features
- Basic Fields
- Fragments
- Inline Fragments
@skip
and@include
directives- Nested fields into dot.notation
npm install --save graphql-list-fields
Usage
import getFieldNames from 'graphql-list-fields';
// in some resolve function
resolve(parent, args, context, info) {
const fields = getFieldNames(info);
return fetch('/someservice/?fields=' + fields.join(','));
}
Depth Limiting
getFieldNames
also accepts an optional depth argument, for how many levels deep results should be returned.
The following will only return top-level fields:
const fields = getFieldNames(info, 1);