Package Exports

lambda-envelope

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lambda-envelope) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

lambda-envelope

Envelope for AWS Lambda responses that supports raw invocation response parsing.

Installation

$ npm install lambda-envelope

Usage

Response

AWS Lambda does not provide a way to separate client and server errors, as errors can't be extended with custom fields. Response class contains methods needed by AWS Lambda to correctly serialize custom response or error as well as helper factory method to parse raw AWS Lambda response. Successful results and client errors should be returned using success callback. Errors that should be treated as server errors and, as a result, be picked up by Amazon CloudWatch, must be returned using error callback.

constructor(options)

Constructor takes options object with optional parameters:

[statusCode] - response status code that should match HTTP status codes, but can be any proprietary value [defaults to 200]
[body] - response body (can be of any type that is JSON.stringify compatible) [defaults to {}]

Example

const Response = require('lambda-envelope').Response;

module.exports.handler = function(event, context, callback) {
  const response = new Response({
    statusCode: 200,
    body: {
      data: 'some data'
    }
  });

  callback(null, response);
}

fromAWSResponse(awsResponse)

Factory method that handles raw AWS Lambda invocation response parsing.

Example

const AWS = require('aws-sdk');
const Response = require('lambda-envelope').Response;

const lambda = new AWS.Lambda();
const params = {
  FunctionName: 'function-to-be-invoked',
  Payload: JSON.stringify({})
};

return lambda.invoke(params)
  .promise()
  .then(rawResponse => Response.fromAWSResponse(rawResponse))
  .then(response => {
    if (response.statusCode === 200) {
      /*success*/
    } else {
      /*error*/
    }
  });

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.