serverless-helpers-js/README.md

Helper functions for Serverless modules.

Serverless Helpers (Node.js Version)
=================================

###Features
* Helps your modules locate and load Stage Variables that the Serverless framework adds on deployment.
* Allows access to the CF Output variables that you defined in the `s-resources-cf.json` file.

## CF Output variables
To have your lambda access the CF output variables you have to give it the `cloudformation:describeStacks` access rights in the lambda IAM role.

The CF.loadVars() promise will add all CF output variables to the process'
environment as *SERVERLESS_CF_`OutVar name`*. It will add a few ms to the
startup time of your lambda.

Change your lambda handler as follows:

```
// Require Serverless ENV vars
var ServerlessHelpers = require('serverless-helpers-js');
ServerlessHelpers.loadEnv();

// Require Logic
var lib = require('../lib');

// Lambda Handler
module.exports.handler = function(event, context) {
  ServerlessHelpers.CF.loadVars()
  .then(function() {
    lib.respond(event, function(error, response) {
      return context.done(error, response);
    });
  })
  .catch(function(err) {
    return context.done(err, null);
  });
};
```