Tweaks to test and readme content

Author: dupski

README.md

@@ -11,10 +11,21 @@ Mainly useful for applications that need to generate graphql queries dynamically
 npm install json-to-graphql-query
 ```
 
+## Usage
+
+```ts
+const query = jsonToGraphQLQuery(queryObject: object, options?: object);
+```
+
+Supported Options:
+ * `pretty: boolean` - optional - set to `true` to enable pretty-printed output
+ * `ignoreFields: string[]` - optional - you can pass an array of object key names that you want removed from the query
+
 ## Features
 
  * Converts a JavaScript object to a GraphQL Query string
  * Full support for nested query / mutation nodes and arguments
+ * Optionally strip specific object keys using the `ignoreFields` option
  * Support for input arguments via [`__args`](#query-with-arguments)
  * Support for query aliases via [`__alias`](#using-aliases)
  * Support for Enum values via [`EnumType`](#query-with-enum-values)
@@ -24,13 +35,6 @@ npm install json-to-graphql-query
 
 See the [CHANGELOG](CHANGELOG.md)
 
-## Usage
-
-**jsonToGraphQLQuery(** queryObject: object, options?: object **)**
-
-Supported options:
- * **pretty**: boolean - Set to `true` to enable pretty-printed output
-
 ### Simple Query
 
 ```typescript
@@ -266,18 +270,18 @@ query ($variable1: String!, $variableWithDefault: String = "default_value") {
 }
 ```
 
-### Ignore fields of the initial object
+### Ignoring fields in the query object
+
 We sometimes want to ignore specific fields in the initial object, for instance __typename in Apollo queries.
-While we can put the field value to `false`, we might want to keep its value.
-You can specify those fields not to be put into the final GraphQL query though the `ignoreFields` option:
+You can specify these fields using the `ignoreFields` option:
 
 ```typescript
 import { jsonToGraphQLQuery, VariableType } from 'json-to-graphql-query';
 
 const query = {
     query: {
         Posts: {
-            __ignore: {
+            shouldBeIgnored: {
                 variable1: 'a value'
             },
             id: true,
@@ -286,7 +290,10 @@ const query = {
         }
     }
 };
-const graphql_query = jsonToGraphQLQuery(query, { pretty: true, ignoreFields: ['__ignore'] });
+const graphql_query = jsonToGraphQLQuery(query, {
+    pretty: true,
+    ignoreFields: ['shouldBeIgnored']
+});
 ```
 
 Resulting `graphql_query`

src/__tests__/jsonToGraphQLQuery.tests.ts

@@ -286,7 +286,7 @@ describe('jsonToGraphQL()', () => {
         const query = {
             query: {
                 Posts: {
-                    __ignore: {
+                    thisShouldBeIgnored: {
                         test: 'a value'
                     },
                     id: true,
@@ -295,7 +295,10 @@ describe('jsonToGraphQL()', () => {
                 }
             }
         };
-        expect(jsonToGraphQLQuery(query, { pretty: true, ignoreFields: ['__ignore'] })).to.equal(
+        expect(jsonToGraphQLQuery(query, {
+            pretty: true,
+            ignoreFields: ['thisShouldBeIgnored']
+        })).to.equal(
             `query {
     Posts {
         id