JSPM

@remusao/smaz

1.9.1-canary.248.f3df6aa7ab7c7c289570786b80e41617052a9ca5.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 73338
  • Score
    100M100P100Q174698F
  • License MPL-2.0

Compress strings using custom codebooks

Package Exports

  • @remusao/smaz

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@remusao/smaz) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@remusao/smaz

Compress strings using custom codebooks

A port of the smaz small string compression library to JavaScript.

From the original library:

Smaz is a simple compression library suitable for compressing very short strings. General purpose compression libraries will build the state needed for compressing data dynamically, in order to be able to compress every kind of data. This is a very good idea, but not for a specific problem: compressing small strings will not work.

Smaz instead is not good for compressing general purpose data, but can compress text by 40-50% in the average case (works better with English), and is able to perform a bit of compression for HTML and urls as well. The important point is that Smaz is able to compress even strings of two or three bytes!

For example the string "the" is compressed into a single byte.

To compare this with other libraries, think that like zlib will usually not be able to compress text shorter than 100 bytes.

Usage

const { compress, decompress } = require('@remusao/smaz');

const compressed = compress('foobar');
console.log(decompress(compressed));