Skip to content

ffleet/shim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AWS Lambda Shim

CircleCI npm

A Better Lambda API

This library provides an abstraction between the AWS Lambda events and classic node.js calling conventions.

This project is sponsored by the Functional Fleet Serverless Platform. We are currently accepting beta users for our platform, featuring a free git repo, hosted deploy queue, and centralized monitoring.

Why

Node.js has developed a familiar set of patterns for certain sets of problems. AWS Lambda, however, uses a slightly different structure in order to maximize flexibility for the Lambda platform.

This library bridges the gap, allowing you to write node.js style code which is automatically translated for use in AWS serverless environments.

Support

This library supports all versions of node.js that are currently supported by AWS Lambda. Currently, that includes:

  • node.js 4.3
  • node.js 6.10
  • node.js 8.10

Wrap

Wrapping your function standardizes the calling conventions across all versions of Node.js and all AWS Lambda event sources. This includes:

  • Supporting Promise returns, rather than the callback argument
  • Standardizing arguments to (event, callback)
  • Providing additional helpers through the this object

Example:

var shim = require('@ffleet/shim');
var myLib = require('./lib');

// callback is not needed with Promise
function mySQSHandler(event) {
	// myLib.handle returns a promise
	return myLib.handle(event);
}

exports.mySQSHandler = shim.wrap(mySQSHandler);

Libraries

HTTP

Node.js HTTP servers are built around request and response objects passing through route handlers. This has been embraced by the common node.js HTTP libraries as well (Express, Hapi, Restify, etc.).

The http shim creates a native node.js HTTP server and proxies the AWS Lambda event.

For example, using a native handler:

const shim = require('@ffleet/shim');

function myNativeHttpHandler(req, res) {
	res.end('Hello, World!');
}

exports.myNativeHttpHandler = shim.http(myNativeHttpHandler);

Or, you can wrap an entire Express server:

const shim = require('@ffleet/shim');
const express = require('express');
const app = express();

app.get('/', function(req, res, next) {
	res.send('Hello, World!');
});

exports.myExpressHttpHandler = shim.http(app);

About

AWS Lambda serverless shim helper library for node.js

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published