@stormkit/serverless v2.3.4

Stormkit servesless provides handy wrappers to make your code work in serverless environments. This makes your function much more portable. The wrapper will take the incoming event and transform it into a Node.js http.IncomingMessage object.

For whom is this package targeted for?

This repository is intended for users who care about portability. If you know you'll be using AWS Lambda and you don't need to make your code portable, then this package may be overengineering for your needs. If, however, you'd like to deploy your application to multiple providers, then this package can be helpful.

If you are using Stormkit and developing an API, you can use this repository to test your application locally.

Installation

npm i @stormkit/serverless

Example usage

import http from "http";
import serverless from "@stormkit/serverless";

export const handler = serverless(
  async (req: http.IncomingMessage, res: http.ServerResponse) => {
    res.write("Hello from " + req.url);
    res.end();
  }
);

By default the above example will use a Stormkit handler. To change this behaviour you can tell the serverless function which handler to use.

export const handler = serverless(
  async (req: http.IncomingMessage, res: http.ServerResponse) => {
    res.write("Hello from " + req.url);
    res.end();
  },
  "awsAlb"
);

To avoid setting the handler type all the time, you can also use the process.env.SERVERLESS_HANDLER environment variable to set a different default type. Allowed types are:

• awsAlb
• stormkit

If you need a different handler, feel free to open a issue 🙏🏻

Currently supported signatures

Each provider has it's own signature to call a serverless function. Here's the list of the currently supported providers:

• Stormkit
• AWS ALB

Dev Server

To test your serverless application locally, execute the following command:

node ./node_modules/@stormkit/serverless/dev-server

This will spin up a local dev server and start serving requests from your /api folder. The Dev Server uses a filesystem routing mechanism, therefore each request will be forwarded to the relevant file. For example:

/user/subscriptions will be routed to $REPO/api/user/subscriptions.ts or $REPO/api/user/subscriptions.js where $REPO is path to your repository. For dynamic paths, you can prefix your subfolders with a double-colon :. For instance, if your folder structure is $REPO/api/user/:id/subscriptions.ts, a request with path /user/15/subscriptions will be matched and served from that file.

If you see a SyntaxError: unexpected token 'export' error try adding the following configuration to the tsconfig.json file:

{
  "compilerOptions": {
    "module": "commonjs"
  }
}

Testing this repo locally

To run an e2e test locally, use the tests/e2e/run.ts file:

ts-node tests/e2e/run.ts --repo <path-to-repo> --dist-dir <path-to-dist>

Make sure that the repo that is tested is built.

License

Made with 💛 Published under MIT.