@crft/appsync-gateway - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

package.json

 {
   "name": "@crft/appsync-gateway",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Utility method for making API calls to AppSync from Lambdas in AWS.",
@@ -5,0 +5,0 @@ "source": "src/index.ts",

README.md

@@ -5,11 +5,31 @@ # Appsync API Gateway
 
+This library essentially implements the suggested approach outlined by [AWS Amplify Docs](https://docs.amplify.aws/lib/graphqlapi/graphql-from-nodejs/q/platform/js) in a nice package.
+
 ## Usage
 
+Install via NPM: 
+
+```
+npm i @crft/appsync-gateway --save
+```
+
+then use like:
+
 ```ts
 const {
   GraphQLGateway,
-  IAMCredentialsStrategy
+  IAMCredentialsStrategy,
+  APIKeyCredentialsStrategy,
+  AuthHeaderCredentialsStrategy
 } = require('@crft/appsync-gateway');
 
+// IAM Mode
 const creds = new IAMCredentialsStrategy();
+
+// API Key Mode
+const creds = new APIKeyCredentialsStrategy(API_KEY);
+
+// Auth Headers Mode
+const creds = new AuthHeaderCredentialsStrategy(authHeader);
+
 const gateway = new GraphQLGateway(
@@ -19,5 +39,23 @@ creds,
 );
+
+const myQuery = `
+  query ListTodosOperation {
+    listTodos {
+      items {
+        title
+      }
+    }
+  }
+`;
+
+await gateway.runQuery({
+  operationName: 'ListTodosOperation',
+  query: myQuery,
+  variables: {
+    input: {}
+  }
+});
 ```
 
 ## Commands
-- `npm build` - Run the typescript build
+- `npm build` - Run the typescript build

No alert changes

Improved metrics

Total package byte prevSize

34008

increased by2.18%

Number of lines in readme file

60

increased by185.71%

No dependency changes