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 i efrt
efrt
is a prefix/suffix trie optimised for compression of english words.
it is based on mckoss/lookups by Mike Koss and bits.js by Steve Hanov
By doing the fancy stuff ahead-of-time, efrt lets you ship much bigger word-lists to the client-side, without much hassle.
var efrt = require('efrt')
var words = [
'coolage',
'cool',
'cool cat',
'cool.com',
'coolamungo'
];
//pack these words as tightly as possible
var compressed = efrt.pack(words);
//cool0;! cat,.com,a0;ge,mungo
//create a lookup-trie
var trie = efrt.unpack(compressed);
//hit it!
console.log(trie.has('cool'));//true
console.log(trie.has('miles davis'));//false
the words you input should be pretty normalized. Spaces and unicode are good, but numbers, case-sensitivity, and some punctuation are not (yet) supported.
##Performance
there are two modes that efrt
can run in, depending on what you want to optimise for.
By itself, it will be ready-instantly, but must lookup words by their prefixes in the trie. This is not super-fast. If you want lookups to go faster, you can call trie.cache()
first, to pre-compute the queries. Things will run much faster after this:
var compressed = efrt.pack(skateboarders);//1k words (on a macbook)
var trie = efrt.unpack(compressed)
trie.has('tony hawk')
// trie-lookup: 1.1ms
trie.cache()
// caching-step: 5.1ms
trie.has('tony hawk')
// cached-lookup: 0.02ms
the trie.cache()
command will spin the trie into a good-old javascript object, for faster lookups. It takes some time building it though.
In this example, with 1k words, it makes sense to hit .cache()
if you are going to do more-than 5 lookups on the trie, but your mileage may vary.
You can access the object from trie._cache
if you'd like use it directly.
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:
##Use 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.has('moe'))
</script>
if you're doing the second step in the client, you can load just the unpack-half of the library(~3k):
<script src="https://unpkg.com/efrt@latest/builds/efrt-unpack.min.js"></script>
<script>
var trie=unpack(compressedStuff);
trie.has('miles davis');
</script>
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.