https://github.com/denosaurs/deno_lz4

🗜 lz4 wasm module for deno
https://github.com/denosaurs/deno_lz4

compression deno lz4

Last synced: 4 months ago
JSON representation

🗜 lz4 wasm module for deno

• Host: GitHub
• URL: https://github.com/denosaurs/deno_lz4
• Owner: denosaurs
• License: mit
• Created: 2020-05-29T13:59:01.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T09:41:16.000Z (10 months ago)
• Last Synced: 2024-04-14T01:00:47.361Z (10 months ago)
• Topics: compression, deno, lz4
• Language: TypeScript
• Homepage: https://deno.land/x/lz4
• Size: 92.8 KB
• Stars: 18
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# deno_lz4

[![stars](https://img.shields.io/github/stars/denosaurs/deno_lz4)](https://github.com/denosaurs/deno_lz4/stargazers)

[![workflow](https://img.shields.io/github/actions/workflow/status/denosaurs/deno_lz4/checks.yml?branch=master)](https://github.com/denosaurs/deno_lz4/actions)

[![releases](https://img.shields.io/github/v/release/denosaurs/deno_lz4)](https://github.com/denosaurs/deno_lz4/releases/latest/)

[![deno version](https://img.shields.io/badge/deno-^1.0.2-informational)](https://github.com/denoland/deno)

[![deno doc](https://img.shields.io/badge/deno-doc-informational)](https://doc.deno.land/https/deno.land/x/deno_lz4/mod.ts)

[![Discord](https://img.shields.io/discord/713043818806509608)](https://discord.gg/shHG8vg)

[![license](https://img.shields.io/github/license/denosaurs/deno_lz4)](https://github.com/denosaurs/deno_lz4/blob/master/LICENSE)

[![issues](https://img.shields.io/github/issues/denosaurs/deno_lz4)](https://github.com/denosaurs/deno_lz4/issues)

This module provides

[lz4](https://en.wikipedia.org/wiki/LZ4_(compression_algorithm)) support for

deno and the web by providing [simple bindings](src/lib.rs) using

[lz4-compression](https://github.com/johannesvollmer/lz4-compression-rs)

compiled to webassembly.

## Usage

### Compression

```ts

import { compress } from "https://deno.land/x/lz4/mod.ts";

const text = new TextEncoder().encode("X".repeat(64));

console.log(text.length); // 64 Bytes

console.log(compress(text).length); // 6  Bytes

```

### Decompression

```ts

import { decompress } from "https://deno.land/x/lz4/mod.ts";

const compressed = Uint8Array.from([31, 88, 1, 0, 44, 0]);

console.log(compressed.length); // 6 Bytes

console.log(decompress(compressed).length); // 64 Bytes

```

## Other

### Contribution

Pull request, issues and feedback are very welcome. Code style is formatted with

`deno fmt` and commit messages are done following

[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec.

### Licence

Copyright 2020-present, the denosaurs team. All rights reserved. MIT license.