Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
trie-search
Advanced tools
A trie implementation that maps keys to objects for rapid retrieval by phrases. Most common use will be for typeahead searches.
A Trie is a data structure designed for rapid reTRIEval of objects. This was designed for use with a type-ahead search (e.g. like a dropdown).
This data structure allows you to map sentences/words to objects, allowing rapid indexing and searching of massive dictionaries
by partial matches. By default, sentences/words are split along word boundaries. For example, if your inserted mapping is
'the quick brown fox', this object will be searchable by 'the', 'quick', 'brown', or 'fox' or any of their partials like
'qui' or 'qu' or 'fo'. Word boundaries can be customized using the splitOnRegEx
option explained in Setup below.
By default, the trie-search is now internationalized for a common set of vowels. So if you insert 'ö', then searching on 'o' will
return that result. You can customize this by providing your own expandRegexes
object. See the source for details.
Note:
new TrieSearch(keyFields, options)
keyFields
: a single string or an array of strings representing what fields on added objects are to be used as keys for the
trie search.
options
: settings to provide to the TrieSearch. To be expanded as functionality grows, but current structure is:
{
min: 1, // Minimum length of a key to store and search. By default this is 1,
// but you might improve performance by using 2 or 3
ignoreCase: true,
indexField: undefined, // Defaults to undefined. If specified, determines which
// rows are unique when using get().
splitOnRegEx: /\s/g // Default regular expression to split all keys into tokens.
// By default this is any whitespace. Set to 'false' if you have
// whitespace in your keys!,
expandRegexes: [...] // By default is an array of international vowels expansions, allowing
// searches for vowels like 'a' to return matches on 'å' or 'ä' etc.
// Set this to an empty array (`[]`) if you want to disable it.
}
All values are converted to a Javascript String object via the .toString()
method before inserted into the Trie structure.
So the words/sentences '1234'
and 1234
are functionally equivalent. This is useful if you want to implement your own
toString()
method on a complex type.
var TrieSearch = require('trie-search');
var object = {
'andrew': {age: 21},
'andy': {age: 37},
'andrea': {age: 25},
'annette': {age: 67},
};
var ts = new TrieSearch();
ts.addFromObject(object);
ts.get('a'); // Returns all 4 items above.
ts.get('an'); // Returns all 4 items above.
ts.get('and'); // Returns all 3 items above that begin with 'and'
ts.get('andr'); // Returns all 2 items above that begin with 'andr'
ts.get('andre'); // Returns only andrew.
var TrieSearch = require('trie-search');
var arr = [
{name: 'andrew', age: 21},
{name: 'andy', age: 37},
{name: 'andrea', age: 25},
{name: 'annette', age: 67}
];
var ts = new TrieSearch('name');
ts.addAll(arr);
ts.get('a'); // Returns all 4 items above.
ts.get('an'); // Returns all 4 items above.
ts.get('and'); // Returns all 3 items above that begin with 'and'
ts.get('andr'); // Returns all 2 items above that begin with 'andr'
ts.get('andre'); // Returns only andrew.
var TrieSearch = require('trie-search');
var arr = [
{name: 'andrew', details: {age: 21}},
{name: 'andy', details: {age: 37}},
{name: 'andrea', details: {age: 25}},
{name: 'annette', details: {age: 67}}
];
var ts = new TrieSearch([
'name', // Searches `object.name`
['details', 'age'] // `Search object.details.age`
]);
ts.addAll(arr);
ts.get('21'); // Returns 'andrew' which has age of 21
var TrieSearch = require('trie-search');
var arr = [
{name: 'andrew', age: 21},
{name: 'andy', age: 37},
{name: 'andrea', age: 25},
{name: 'annette', age: 67}
];
var ts = new TrieSearch('name', {min: 3});
ts.addAll(arr);
ts.get('a'); // Returns empty array, too short of search
ts.get('an'); // Returns empty array, too short of search
ts.get('and'); // Returns all 3 items above that begin with 'and'
ts.get('andr'); // Returns all 2 items above that begin with 'andr'
ts.get('andre'); // Returns only andrew.
By default, the HashArray object (which TrieSearch uses) does not - for the sake of speed - verify object uniqueness by the object itself, but instead by a field on that object.
As a result, in order for get()
to be used with multiple words, it is important that a field is used to identify each record in the TrieSearch, similar to a index in a database.
var TrieSearch = require('trie-search');
var arr = [
{ix: 1, name: 'andrew', location: 'sweden', age: 21},
{ix: 2, name: 'andrew', location: 'brussels', age: 37},
{ix: 3, name: 'andrew', location: 'johnsonville', age: 25}
];
var ts = new TrieSearch('name', {min: 3, indexField: 'ix'});
ts.addAll(arr);
ts.get('andrew'); // Returns all items
ts.get('andrew sweden'); // Returns all items without indexField. Returns only andrew in sweden with indexField.
var TrieSearch = require('trie-search');
var arr = [
{name: 'andrew', age: 21, zip: 60600},
{name: 'andy', age: 37, zip: 60601},
{name: 'andrea', age: 25, zip: 60602},
{name: 'joseph', age: 67, zip: 60603}
];
var ts = new TrieSearch(['name', 'age', 'zip']);
ts.addAll(arr);
ts.get('andre'); // Returns only andrew.
ts.get(['andre', '25']); // Returns andrew AND andrea
ts.get(['andre', 'jos']); // Returns andrew AND joseph
ts.get(['21', '67']); // Returns andrew AND joseph
ts.get(['21', '60603']); // Returns andrew AND joseph
var TrieSearch = require('trie-search');
var arr = [
{name: 'andrew', age: 21, zip: 60600, id: 1}, // person1
{name: 'andrew', age: 37, zip: 60601, id: 2}, // person2
{name: 'andrew', age: 25, zip: 60602, id: 3}, // person3
{name: 'andrew', age: 37, zip: 60603, id: 4} // person4
];
var ts = new TrieSearch(['name', 'age', 'zip'], {
idFieldOrFunction: 'id' // Required to uniquely identify during union (AND)
});
ts.addAll(arr);
ts.get(['andrew', '25'], TrieSearch.UNION_REDUCER); // [person3]
ts.get(['andrew', '50'], TrieSearch.UNION_REDUCER); // []
ts.get(['andrew', '37'], TrieSearch.UNION_REDUCER); // [person2, person4]
$ npm i -g mocha
$ mocha
START
․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․
73 passing (25ms)
The MIT License (MIT)
Copyright (c) 2018 Joshua Jung
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A trie implementation that maps keys to objects for rapid retrieval by phrases. Most common use will be for typeahead searches.
The npm package trie-search receives a total of 26,839 weekly downloads. As such, trie-search popularity was classified as popular.
We found that trie-search 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.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.