Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
npm install efrt
if your data looks like this:
var data = {
bedfordshire: 'England',
aberdeenshire: 'Scotland',
buckinghamshire: 'England',
argyllshire: 'Scotland',
bambridgeshire: 'England',
cheshire: 'England',
ayrshire: 'Scotland',
banffshire: 'Scotland'
};
you can compress it like this:
var str = efrt.pack(data);
//'England:b0che1;ambridge0edford0uckingham0;shire|Scotland:a0banff1;berdeen0rgyll0yr0;shire'
then _very!_ quickly flip it back into:
var obj = efrt.unpack(str);
obj['bedfordshire'];//'England'
efrt packs category-type data into a very compressed prefix trie format, so that redundancies in the data are shared, and nothing is repeated.
By doing this clever-stuff ahead-of-time, efrt lets you ship much more data to the client-side, without hassle or overhead.
The whole library is 8kb, the unpack half is barely 2kb.
it is based on:
var efrt = require('efrt')
var foods = {
strawberry: 'fruit',
blueberry: 'fruit',
blackberry: 'fruit',
tomato: ['fruit', 'vegetable'],
cucumber: 'vegetable',
pepper: 'vegetable'
};
var str = efrt.pack(foods);
//'{"fruit":"bl0straw1tomato;ack0ue0;berry","vegetable":"cucumb0pepp0tomato;er"}'
var obj=efrt.unpack(str)
console.log(obj.tomato)
//['fruit', 'vegetable']
the keys of the object are normalized. Spaces/unicode are good, but numbers, case-sensitivity, and some punctuation (semicolon, comma, exclamation-mark) are not (yet) supported.
specialChars = new RegExp('[0-9A-Z,;!:|¦]')
efrt is built-for, and used heavily in compromise, to expand the amount of data it can ship onto the client-side. If you find another use for efrt, please drop us a line🎈
efrt is tuned to be very quick to unzip. It is O(1) to lookup. Packing-up the data is the slowest part, which is usually fine:
var compressed = efrt.pack(skateboarders);//1k words (on a macbook)
var trie = efrt.unpack(compressed)
// unpacking-step: 5.1ms
trie.hasOwnProperty('tony hawk')
// cached-lookup: 0.02ms
efrt
will pack filesize down as much as possible, depending upon the redundancy of the prefixes/suffixes in the words, and the size of the list.
1.5k -> 0.8k
(46% compressed)58k -> 24k
(58% compressed)265k -> 99k
(62% compressed)1,775k -> 692k
(61% compressed)but there are some things to consider:
Assuming your data has a low category-to-data ratio, you will hit-breakeven with at about 250 keys. If your data is in the thousands, you can very be confident about saving your users some considerable bandwidth.
IE9+
<script src="https://unpkg.com/efrt@latest/builds/efrt.min.js"></script>
<script>
var smaller=efrt.pack(['larry','curly','moe'])
var trie=efrt.unpack(smaller)
console.log(trie['moe'])
</script>
if you're doing the second step in the client, you can load just the unpack-half of the library(~3k):
npm install efrt-unpack
<script src="https://unpkg.com/efrt@latest/builds/efrt-unpack.min.js"></script>
<script>
var trie=unpack(compressedStuff);
trie.hasOwnProperty('miles davis');
</script>
Thanks to John Resig for his fun trie-compression post on his blog, and Wiktor Jakubczyc for his performance analysis work
MIT
FAQs
neato compression of key-value data
The npm package efrt receives a total of 44,806 weekly downloads. As such, efrt popularity was classified as popular.
We found that efrt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new license scanner with an improved suite of features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.