Nihilist Pocket Monsters

    serverless-http
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.2 • Public • Published

    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.

    Sponsors

    Thank you to Upstash for reaching out to sponsor this project!

    Upstash

    Upstash: Serverless Database for Redis

    • Serverless Redis with global replication and durable storage
    • Price scales to zero with per request pricing
    • Built-in REST API designed for serverless and edge functions

    Start for free in 30 seconds!

    Support

    Supported Frameworks

    (* Experimental)

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

    Supported Providers

    • AWS
    • Azure (Experimental, untested, probably outdated)

    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 = new 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) => {
      // you can do other things here
      const result = await handler(event, context);
      // and here
      return result;
    };

    Usage example using the Express framework with Azure

    const serverless = require('serverless-http');
    const express = require('express');
    
    const app = express();
    
    app.use(/* register your middleware as normal */);
    
    const handler = serverless(app, { provider: 'azure' });
    module.exports.funcName = async (context, req) => {
      context.res = await handler(context, req);
    }

    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

    Install

    npm i serverless-http

    DownloadsWeekly Downloads

    148,629

    Version

    3.0.2

    License

    MIT

    Unpacked Size

    36.3 kB

    Total Files

    23

    Last publish

    Collaborators

    • rschick
    • microservice-admin
    • dougmoscrop
    • dmoscrop