Rename calculateComplexity > getComplexity, improve documentation #16

Author: ivome

README.md

@@ -104,32 +104,6 @@ type ComplexityEstimatorArgs = {
 type ComplexityEstimator = (options: ComplexityEstimatorArgs) => number | void;
 ```
 
-## Calculate query complexity
-```javascript
-import { calculateComplexity, simpleEstimator } from "graphql-query-complexity/dist/QueryComplexity";
-import { parse } from 'graphql';
-
-// In a resolver the schema can be retrieved from the info argument.
-const schema = undefined; 
-const query = parse(`
-  query {
-    some_value
-    some_list(count: 10) {
-      some_child_value
-    }
-  }
-`);
-
-const complexity = calculateComplexity({
-  estimators: [
-    simpleEstimator({defaultComplexity: 1})
-  ],
-  schema,
-  query
-});
-
-console.log(complexity); // Output: 3
-```
 
 ## Usage with express-graphql
 
@@ -153,6 +127,43 @@ app.use('/api', graphqlHTTP(async (request, response, {variables}) => ({
 })));
 ```
 
+## Calculate query complexity
+
+If you want to calculate the complexity of a GraphQL query outside of the validation phase, for example to
+return the complexity value in a resolver, you can calculate the complexity via `getComplexity`:
+
+```javascript
+import { getComplexity, simpleEstimator } from 'graphql-query-complexity';
+import { parse } from 'graphql';
+
+// Import your schema or get it form the info object in your resolver
+import schema from './schema';
+
+// You can also use gql template tag to get the parsed query
+const query = parse(`
+  query Q($count: Int) {
+    some_value
+    some_list(count: $count) {
+      some_child_value
+    }
+  }
+`);
+
+const complexity = getComplexity({
+  estimators: [
+    simpleEstimator({defaultComplexity: 1})
+  ],
+  schema,
+  query,
+  variables: {
+    count: 10,
+  },
+});
+
+console.log(complexity); // Output: 3
+```
+
+
 ## Prior Art
 
 This project is inspired by the following prior projects: 

src/QueryComplexity.ts

@@ -76,7 +76,7 @@ function queryComplexityMessage(max: number, actual: number): string {
   );
 }
 
-export function calculateComplexity(options: {
+export function getComplexity(options: {
   estimators: ComplexityEstimator[],
   schema: GraphQLSchema,
   query: DocumentNode,

src/__tests__/QueryComplexity-test.ts

@@ -14,7 +14,7 @@ import {expect} from 'chai';
 
 import schema from './fixtures/schema';
 
-import ComplexityVisitor, {calculateComplexity} from '../QueryComplexity';
+import ComplexityVisitor, {getComplexity} from '../QueryComplexity';
 import {
   simpleEstimator,
   fieldConfigEstimator,
@@ -30,7 +30,7 @@ describe('QueryComplexity analysis', () => {
       }
     `);
 
-    const complexity = calculateComplexity({
+    const complexity = getComplexity({
       estimators: [
         simpleEstimator({defaultComplexity: 1})
       ],