Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nullserve/faaskit
A lightweight middleware framework for functions as a service
https://github.com/nullserve/faaskit
aws aws-lambda aws-sam azure azure-functions cloudflare cloudflare-workers faas faas-framework faaskit gcp gcp-cloud-functions hacktoberfest lambda middleware nullserve sam severless
Last synced: 3 months ago
JSON representation
A lightweight middleware framework for functions as a service
- Host: GitHub
- URL: https://github.com/nullserve/faaskit
- Owner: nullserve
- License: apache-2.0
- Created: 2018-10-30T04:30:56.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-10-30T18:49:43.000Z (over 2 years ago)
- Last Synced: 2024-11-16T21:59:45.263Z (3 months ago)
- Topics: aws, aws-lambda, aws-sam, azure, azure-functions, cloudflare, cloudflare-workers, faas, faas-framework, faaskit, gcp, gcp-cloud-functions, hacktoberfest, lambda, middleware, nullserve, sam, severless
- Language: TypeScript
- Homepage:
- Size: 1.47 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FaaSKit
[](https://www.npmjs.com/package/@faaskit/core)
_A lightweight functional middleware framework for AWS lambda that stays out of your way and lets you build kick-ass, composable middleware for your lambdas._
Zero dependencies. Functional interface. Reusable code.
## Table of Contents
- [Installation](#installation)
- [Project Purpose](#project-purpose)
- [Packages](#packages)
## Installation
To use `faaskit` in your nodejs project,
```bash
yarn add @faaskit/core
```
or
```bash
npm i @faaskit/core
```
`@faaskit/core` has no dependencies itself (peer or otherwise), so that's it!
## Project Purpose
The goal of this project is to provide a very thin middleware framework for functions as a service.
Without a well-established middleware pattern, too many bad habits can fossilize from one-off functions into bad middleware.
This library provides a `compose` function for creating coposition-style middleware and wrapping around a handler without having deeply nested code.
This function wrapping pattern allows explicitly definied, functional and onion-style (a well-established style) middleware.
`@faaskit/core` also builds on the basic compose function, offering a few patterns that the author(s) have seen in the wild for rapid customization.
Too many middlework frameworks enforce bad designs and opinions onto their users.
`faaskit` doesn't impose much at all and it stays out of your way once you define your stack.
## Packages
FaasKit provides a number of small packages so developers can easily pick and choose features and middleware which are applicable to their use case.
The packages are organized using the following naming scheme:
* `adapter-`: Adapter packages are used for changing the structure of the call site.
These are useful for hooking up FaasKit to existing systems in a variety of ways.
Including different function runtimes, different middleware stacks or existing legacy functions.
* `middleware-`: Middleware packages are used to provide some common middleware functionality.
They typically identify their use case in the name of the middleware.
These middleware are common patterns and expected workflow that have already been established and should be easy to use just by installing the package and composing the middleware into a middleware stack.
* ``: Common goal packages are named without any prefix and are designed around a common goal of middleware.
For example, the `http` package defines a number of utility functions, middleware, contexts and adapters which help anyone using `http` and will be used by other external packages including `middleware-` packages and `adapter-` packages.
Typically these packages are foundational and used by middleware authors to create a consistent experience between FaaS platforms.