https://github.com/alixaxel/lambdafs
Efficient (de)compression package for AWS Lambda
https://github.com/alixaxel/lambdafs
aws aws-lambda brotli decompression gzip serverless
Last synced: about 1 year ago
JSON representation
Efficient (de)compression package for AWS Lambda
- Host: GitHub
- URL: https://github.com/alixaxel/lambdafs
- Owner: alixaxel
- License: mit
- Created: 2019-09-14T11:27:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-24T16:46:21.000Z (over 4 years ago)
- Last Synced: 2025-03-16T02:47:38.328Z (about 1 year ago)
- Topics: aws, aws-lambda, brotli, decompression, gzip, serverless
- Language: TypeScript
- Homepage:
- Size: 399 KB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# LambdaFS
[](https://www.npmjs.com/package/lambdafs)
[](https://www.typescriptlang.org/dt/search?search=lambdafs)
[](https://paypal.me/alixaxel)
Efficient (de)compression package for AWS Lambda, supporting **Brolti**, **Gzip** and **Tarballs**
## Install
```shell
npm install lambdafs --save-prod
```
## CLI
This package provides a [`brotli` CLI command](/bin) to conveniently compress files and/or folders.
```shell
npx lambdafs /path/to/compress
```
The resulting file will be a (potentially tarballed) Brotli compressed file, with the same base name as the source.
> Due to the highest compression level, it might take a while to compress large files (100MB ~ 5 minutes).
## Usage
The `nodejs12.x` or `nodejs14.x` AWS Lambda runtime is required for this package to work properly.
```javascript
const lambdafs = require('lambdafs');
exports.handler = async (event, context) => {
try {
let file = __filename; // /var/task/index.js
let folder = __dirname; // /var/task
// Compressing
let compressed = {
file: await lambdafs.deflate(file), // /tmp/index.js.gz
folder: await lambdafs.deflate(folder), // /tmp/task.tar.gz
};
// Decompressing
let decompressed = {
file: await lambdafs.inflate(compressed.file), // /tmp/index.js
folder: await lambdafs.inflate(compressed.folder), // /tmp/task
};
return context.succeed({ file, folder, compressed, decompressed });
} catch (error) {
return context.fail(error);
}
};
```
## API
### `deflate(path: string): Promise`
Compresses a file/folder with Gzip and returns the path to the compressed (tarballed) file.
> The resulting file will be saved under the default temporary directory (`/tmp` on AWS Lambda).
Due to costly execution time on AWS Lambda, Gzip is *always* used to compress files.
### `inflate(path: string): Promise`
Decompresses a (tarballed) Brotli or Gzip compressed file and returns the path to the decompressed file/folder.
> The resulting file(s) will be saved under the default temporary directory (`/tmp` on AWS Lambda).
Supported extensions are: `.br`, `.gz`, `.tar`, `.tar.br` (and `.tbr`), `.tar.gz` (and `.tgz`).
> For tarballs, original file modes are perserved. For any other files `0700` is assumed.
## Rationale
Getting large resources onto AWS Lambda can be a challenging task due to the [deployment package size limit](https://docs.aws.amazon.com/lambda/latest/dg/limits.html#w291aac11c35c15):
| Limit | Context |
| ------ | --------------------------- |
| 50 MB | Zipped, for direct uploads. |
| 250 MB | Unzipped, S3 and layers. |
For this reason, it's important to achieve a very high compression ratio as well as fast decompression times.
This is where the [Brotli algorithm](https://www.opencpu.org/posts/brotli-benchmarks/) comes in:
It allows us to get the best compression ratio and fast decompression times (at the expense of a slow compression).
## License
MIT