Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shgysk8zer0/lambda-http
A collection of node >+ 20 utilities for Netlify Functions and AWS Lambda
https://github.com/shgysk8zer0/lambda-http
aws formdata lambda netlify npm request response
Last synced: 2 days ago
JSON representation
A collection of node >+ 20 utilities for Netlify Functions and AWS Lambda
- Host: GitHub
- URL: https://github.com/shgysk8zer0/lambda-http
- Owner: shgysk8zer0
- License: mit
- Created: 2024-07-25T22:17:19.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-09-15T16:35:12.000Z (18 days ago)
- Last Synced: 2024-09-16T17:13:01.443Z (17 days ago)
- Topics: aws, formdata, lambda, netlify, npm, request, response
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@shgysk8zer0/lambda-http
- Size: 3.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `@shgysk8zer0/lambda-http`
A collection of node >= 20 utilities for Netlify Functions and AWS Lambda
[](https://github.com/shgysk8zer0/lambda-http/actions/workflows/codeql-analysis.yml)
[](https://github.com/shgysk8zer0/lambda-http/blob/master/LICENSE)
[](https://github.com/shgysk8zer0/lambda-http/commits/master)
[](https://github.com/shgysk8zer0/lambda-http/releases)
[](https://github.com/sponsors/shgysk8zer0)
[](https://www.npmjs.com/package/@shgysk8zer0/lambda-http)
[](https://www.npmjs.com/package/@shgysk8zer0/lambda-http)
[](https://github.com/shgysk8zer0)
[](https://twitter.com/shgysk8zer0)
[](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")
- - -
- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
- [Contributing](./.github/CONTRIBUTING.md)
This package makes use of node >= 20 having support for the familiar [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
& [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) objects to provide easier and more standards-based
way of creating [ Netlify Functions](https://docs.netlify.com/functions/overview/) and (theoretically) AWS Lambda.
## Benefits
- Familiar `Request` & `Response` objects
- Built-in support for `FormData` & `File`s & `Blob`s
- Easy support for CORS while still being customizable
- Convenient `{ [method]: async handler(requset) }` syntax
- Constants for HTTP Status Codes & common Mime-Types
- A custom HTTPError class
- Currently weighs in at only 42.5 kB (unpacked size, including ESM & CJS & & README LICENSE & CHANGELOG)
## Example
```js
import { createHandler, HTTPError, HTTP_STATUS } from '@shgysk8zer0/lambda-http';
export default createHandler({
async get(req) {
return Response.json({
url: req.url,
method: req.method,
headers: Object.fromEntries(req.headers),
});
},
async post(req) {
const data = await req.formData();
// Or `req.json()`
if (! (data.has('email') && data.has('password'))) {
throw new HTTPError('Email and password are required', HTTP_STATUS.BAD_REQUEST);
} else {
// Sign-in logic here
return Response.json(user);
}
},
async put(req) {
const blob = await req.blob();
// Or use `req.arrayBuffer()`
// Maybe save it as a file...
return new Response(null, { status: HTTP_STATUS.NO_CONTENT });
}
async delete(req) {
const params = new URLSearchParams(req.url);
if (params.has('id')) {
// Handle some delete operation
} else {
throw new HTTPError('Missing required id.', HTTP_STATUS.BAD_REQUEST);
}
}
}, {
allowOrigins: ['https://example.com'],
allowHeaders: ['Authorization'],
exposeHeaders: ['X-Foo'],
allowCredentials: true,
logger(err, req) {
console.error({ err, req });
}
});
```
## CommonJS (`require()`) Note
This is primarily intended for use with ES Modules, though CJS files are generated via Rollup.
Because of this, bear in mind that default exports and named exports do not perfectly translate,
and you cannot just use `const createHandler = require('@shgysk8zer0/lambda-http')` like you can
with modules. You'll have to use `const { createHandler } = require('@shgysk8zer0/lambda-http')`
or `const { default: createHandler } = require('@shgysk8zer0/lambda-http')`.