Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pwntus/node-aws-lambda-ag
Tiny AWS Node helper for API Gateway Lambda proxies
https://github.com/pwntus/node-aws-lambda-ag
Last synced: 5 days ago
JSON representation
Tiny AWS Node helper for API Gateway Lambda proxies
- Host: GitHub
- URL: https://github.com/pwntus/node-aws-lambda-ag
- Owner: Pwntus
- License: mit
- Created: 2017-05-13T09:36:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-05-15T17:05:50.000Z (over 7 years ago)
- Last Synced: 2024-12-15T19:05:37.848Z (7 days ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node AWS Lambda API Gateway
A tiny AWS Node helper for [API Gateway Lambda proxies](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy-for-lambda.html).
Useful for handling gateway parameters (both query and body), require parameters, setting default values and responses.
## Install
Using npm:
```
npm install node-aws-lambda-ag --save
```
## Usage
```javascript
var AG = require('node-aws-lambda-ag')
// Using ES6 syntax
// import AG from 'node-aws-lambda-ag'
// Define expected API Gateway parameters
const PARAMS = [
{
name: 'category',
required: true,
default: 'none'
},
{
name: 'offset',
required: false,
default: 0
},
{
name: 'limit',
required: false,
default: 15
}
]
export const main = (event, context, callback) => {
// Initialize the helper with predefined parameters
let ag = new AG(event, PARAMS, callback)
// Fetch parameters
console.log('Got param: ', ag.param('category'))
// Send failed response
if (ag.param('limit') > 100)
ag.failure({ error: 'Limit overflow' })
// Send successful response
else
ag.success({ status: 'ok' })
}
```
If a callback method is provided and a required parameter is absent in the event object, a failed response will automatically be issued.
## API
#### Constructor
```javascript
constructor(event, params, callback = null)
```
- **event** (object) - the AWS Lambda [event](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html).
- **params** (array) - your predefined parameters.
- **callback** (function, optional) - the [callback](http://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html#nodejs-prog-model-handler-callback) function used by responses.
#### Retrieveing a parameter
```javascript
AG.param(name)
```
- **name** (string) - the name of the param to retrieve. If the param was not provided in the request a predefined default value will be returned. If no default value is defined, or the param is non-existing, `null` will be returned.
#### Sending a success response
```javascript
AG.success(response)
```
- **response** (object) - send a status 200 response with the provided object.
#### Sending a failed response
```javascript
AG.failure(response, statusCode = 500)
```
- **response** (object) - send a status 500 response with the provided object.
- **statusCode** (number, optional) - specify the HTTP status code.