Lambda-edge-server NPM

lambda-edge-server

AWS CloudFront Lambda@Edge function handler emulator.

Provides a translation layer between Node.js HTTP server and Lambda function response format. The goal is simplify local testing without the need for complex dependencies.

Dependencies

Node.js

Installation

Install this package using NPM:

$ npm install lambda-edge-server

Lambda function handlers

The following origin-request/origin-response format is currently supported.

Synchronous example

/**
 * @see AWS::Serverless::Function
 */
exports.handler = function(event, context, callback) {
  const response = {
    status: '200',
    statusDescription: 'OK',
    headers: {
      'cache-control': [{
        key: 'Cache-Control',
        value: 'max-age=0'
      }],
      'content-type': [{
        key: 'Content-Type',
        value: 'text/html'
      }]
    },
    body: 'Success',
  };

  callback(null, response);
};

Asynchronous example

/**
 * @see AWS::Serverless::Function
 */
exports.handler = async function(event) {
  const response = {
    status: '200',
    statusDescription: 'OK',
    headers: {
      'cache-control': [{
        key: 'Cache-Control',
        value: 'max-age=0'
      }],
      'content-type': [{
        key: 'Content-Type',
        value: 'text/html'
      }]
    },
    body: 'Success',
  };

  return response;
};

Developers

CLI options

Launch HTTP server instance, run the function:

$ npm start ./path/to/script.js

Run ESLint on project sources:

$ npm run lint

Run Mocha integration tests:

$ npm run test

References

Contributions

If you fix a bug, or have a code you want to contribute, please send a pull-request with your changes. (Note: Before committing your code please ensure that you are following the Node.js style guide)

Versioning

This package is maintained under the Semantic Versioning guidelines.

License and Warranty

This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

lambda-edge-server is provided under the terms of the MIT license

AWS is a registered trademark of Amazon Web Services, Inc.