https://github.com/ankcorn/beedi
An opinionated and lightweight library of helpers for building lambdas
https://github.com/ankcorn/beedi
aws dependency-injection lambdas serverless
Last synced: about 1 year ago
JSON representation
An opinionated and lightweight library of helpers for building lambdas
- Host: GitHub
- URL: https://github.com/ankcorn/beedi
- Owner: Ankcorn
- Created: 2020-10-23T00:57:02.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-19T17:01:37.000Z (over 5 years ago)
- Last Synced: 2025-02-14T00:52:04.975Z (about 1 year ago)
- Topics: aws, dependency-injection, lambdas, serverless
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BeeDI / 🐝 DI
BeeDI is an opinionated and lightweight library of helpers for building lambdas. It helps you build tidy and testable lambda functions.
It simplifies interfacing with aws event sources by limiting and preparsing the input. The aim is to support all the most common event sources.
## Simple Example
```js
import { jsonapi } from 'beedi';
async function app(event) {
// The handler just contains the logic.
// event.body has been json parsed.
return {
message: 'I get json stringified'
}
}
export const handler = jsonapi(app);
```
## Why choose BeeDI
Its super early days. BeeDI is not used in production anywhere and is just a fun hobby project. I would not recomend using this in production. If you want something with a similar style but more feature complete, better tested, and well maintained check out https://middy.js.org/ and https://laconiajs.io/.
With that disclamer out the way beedi does have some upsides.
* It's really lightweight. (1kb unminified)
* It has no external dependencies.
* The interface is really simple. Each helper takes an object that contains just a couple of parameters.
* No legacy bagage. No support for callbacks. This means less work to maintain it and it is much lighter. This also could be considered a bad thing. 🤷♂️
* The internal code is very low abstraction and very simple. Take a peek under the hood. There really is very little magic to make this happen.
If you give it a try let me know by leaving a star
## Table of Contents
* [Simple Example](#simple-example)
* [Why choose BeeDI](#why-choose-beedi)
* [Table of Contents](#table-of-contents)
* [Installation](#installation)
* [Examples](#examples)
* [Testing](#testing)
* [Contributions](#contributions)
## Installation
## Examples
### Dependency Injection
```js
import { jsonapi } from 'beedi';
import { pg } from 'pg-sql';
export async function app(event, { pg }) {
// The handler just contains the logic.
// event.body has been json parsed.
await pg.sql('INSERT blah...');
return {
message: 'I get json stringified'
}
}
export const handler = jsonapi(app, { dependencies: () => ({ pg }));
```
## Testing
## Contributions