JSPM

  • Created
  • Published
  • Downloads 188744
  • Score
    100M100P100Q163188F
  • License MIT

Use existing web application frameworks in serverless environments

Package Exports

  • serverless-http
  • serverless-http/lib/request
  • serverless-http/lib/response

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 (serverless-http) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serverless-http

Build Status

Description

This module allows you to 'wrap' your API for serverless use. No HTTP server, no ports or sockets. Just your code in the same execution pipeline you are already familiar with.

Support

Supported Frameworks

  • Connect
  • Express
  • Koa
  • Restana
  • Sails *
  • Hapi *
  • Fastify *
  • Restify *

(* Experimental)

Supported Providers

  • AWS

Examples

Please check the examples folder!

Usage example using the Koa framework

const serverless = require('serverless-http');
const koa = require('koa'); // or any supported framework

const app = koa();

app.use(/* register your middleware as normal */);

// this is it!
module.exports.handler = serverless(app);

// or as a promise
const handler = serverless(app);
module.exports.handler = async (event, context) => {
  return await handler(event, context);
};

Other examples

json-server-less-λ - using serverless-http with json-server and serverless framework in AWS

Limitations

Your code is running in a serverless environment. You cannot rely on your server being 'up' in the sense that you can/should not use in-memory sessions, web sockets, etc. You are also subject to provider specific restrictions on request/response size, duration, etc.

Think of this as a familiar way of expressing your app logic, not trying to make serverless do something it cannot.

Contributing

Pull requests are welcome! Especially test scenarios for different situations and configurations.

Further Reading

Here are some more detailed examples and advanced configuration options as well as provider-specific documentation