Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hazae41/foras
WebAssembly port of Deflate, Gzip, and Zlib compression algorithms
https://github.com/hazae41/foras
browser compression deflate deno gzip javascript rust typescript wasm web webassembly webcrypto zlib
Last synced: 13 days ago
JSON representation
WebAssembly port of Deflate, Gzip, and Zlib compression algorithms
- Host: GitHub
- URL: https://github.com/hazae41/foras
- Owner: hazae41
- License: unlicense
- Created: 2020-06-26T21:36:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T19:10:43.000Z (8 months ago)
- Last Synced: 2024-05-01T18:53:59.201Z (7 months ago)
- Topics: browser, compression, deflate, deno, gzip, javascript, rust, typescript, wasm, web, webassembly, webcrypto, zlib
- Language: TypeScript
- Homepage:
- Size: 2.12 MB
- Stars: 136
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Foras
WebAssembly port of Deflate, Gzip, and Zlib compression algorithms
**DEPRECATED**: You should use native [Compression Streams](https://developer.mozilla.org/en-US/docs/Web/API/Compression_Streams_API) instead
```bash
npm i @hazae41/foras
```
[**Node Package 📦**](https://www.npmjs.com/package/@hazae41/foras) • [**Deno Module 🦖**](https://deno.land/x/foras) • [**Next.js CodeSandbox 🪣**](https://codesandbox.io/p/github/hazae41/foras-example-next)
## Algorithms
- Deflate from flate2
- Gzip from flate2
- Zlib from flate2
## Features
- Reproducible building
- Pre-bundled and streamed
- Zero-copy memory slices
## Usage
### Direct
```ts
import { Foras, deflate, inflate } from "@hazae41/foras";
// or { Foras, gzip, gunzip }
// or { Foras, zlib, unzlib }
// Wait for WASM to load
await Foras.initBundledOnce()
const bytes = new TextEncoder().encode("Hello world")
const compressed = deflate(bytes).copyAndDispose()
const decompressed = inflate(compressed).copyAndDispose()
```
### Streaming
```ts
import { Foras, DeflateEncoder, DeflateDecoder } from "@hazae41/foras";
// or { Foras, GzEncoder, GzDecoder }
// or { Foras, ZlibEncoder, ZlibDecoder }
// Wait for WASM to load
await Foras.initBundledOnce()
const bytes = new TextEncoder().encode("Hello world")
const compresser = new DeflateEncoder()
compresser.write(bytes)
compresser.flush()
const compressed1 = compresser.read().copyAndDispose()
const compressed2 = compresser.finish().copyAndDispose()
compresser.free()
```
## Building
### Unreproducible building
You need to install [Rust](https://www.rust-lang.org/tools/install)
Then, install [wasm-pack](https://github.com/rustwasm/wasm-pack)
```bash
cargo install wasm-pack
```
Finally, do a clean install and build
```bash
npm ci && npm run build
```
### Reproducible building
You can build the exact same bytecode using Docker, just be sure you're on a `linux/amd64` host
```bash
docker compose up --build
```
Then check that all the files are the same using `git status`
```bash
git status --porcelain
```
If the output is empty then the bytecode is the same as the one I commited
### Automated checks
Each time I commit to the repository, the GitHub's CI does the following:
- Clone the repository
- Reproduce the build using `docker compose up --build`
- Throw an error if the `git status --porcelain` output is not empty
Each time I release a new version tag on GitHub, the GitHub's CI does the following:
- Clone the repository
- Do not reproduce the build, as it's already checked by the task above
- Throw an error if there is a `npm diff` between the cloned repository and the same version tag on NPM
If a version is present on NPM but not on GitHub, do not use!