var trie = require('trie-prefix-tree');

// using ES2015 Modules
import trie from 'trie-prefix-tree';

var myTrie = trie(['cat', 'cats', 'dogs', 'elephant', 'tiger']);

// retrieve a stringified dump of the Trie object
myTrie.dump(); // { c: { a: { t: $: 1 }, s: 1 ... }}

// optionally pass in spacer parameter to format the output string
myTrie.dump(2); // equivalent of JSON.stringify(obj, null, 2);

// retrieve the Trie object instance
myTrie.tree();

// add a new word to the Trie
myTrie.addWord('lion');

// remove an existing word from the Trie
myTrie.removeWord('dogs');

myTrie.addWord('hello').removeWord('hello');

// check if a prefix exists:
myTrie.isPrefix('do'); // true
myTrie.isPrefix('z'); // false

// count prefixes
myTrie.countPrefix('c'); // 2

// get an array of words with the passed in prefix
myTrie.getPrefix('c'); // ['cat', 'cats']

// Pass false as the second parameter to disable 
// output being sorted alphabetically
// this is useful when your dictionary is already sorted
// and will therefore save performance
myTrie.getPrefix('c', false); // ['cat', 'cats']

// get a random word at a prefix
myTrie.getRandomWordWithPrefix('c'); // 'cat'
myTrie.getRandomWordWithPrefix('c'); // 'cats'

// retrieve a full list of words in the Trie
// the output array is automatically sorted
myTrie.getWords(); // ['cat', 'cats', 'elephant', 'lion', 'tiger']

// pass false to disable the output being sorted
// this is useful when your dictionary is already sorted
// and will therefore save performance
myTrie.getWords(false); // ['cat', 'cats', 'elephant', 'tiger', 'lion']

// check if a word exists in the Trie
myTrie.hasWord('elephant'); // true
myTrie.hasWord('zoo'); // false

// generate a list of valid anagrams from the given letters
myTrie.getAnagrams('act'); // ['cat'];

// generate a list of valid sub-anagrams from the given letters
myTrie.getSubAnagrams('ctalion'); ['cat', 'cats', 'lion'];