Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

prefix-trie-ts

ClickSimply146MIT0.0.4TypeScript support: included

Create and modify trie prefix structures, extract word lists including anagrams and sub-anagrams

javascript, trie, words, prefix-trie, tree, prefix, autocomplete

readme

Prefix Trie TS

Smallest possible Trie implimintation written in Typescript.

Features

  • Prefix trie for autocomplete.
  • Less than 800 bytes gzipped.
  • Full typescript support.
  • Trie is not case sensitive.

Installation

npm i prefix-trie-ts

Browser

  • Include dist/prefixTrie.min.js on your page with a script tag.

NodeJS

const Trie = requie("prefix-trie-ts").Trie;

Typescript

import { Trie } from "prefix-trie-ts";

Usage

var trie = new Trie(["scott","jeb"]);
trie.addWord("john");
console.log(trie.getPrefix("j")) // <= ["john","jeb"]

Methods

Constructor

Optionally pass in the list of strings to search.

var trie = new Trie(["name1","name2"...])

Add Word

Add a word to the trie.

trie.addWord("name3");

Remove Word

Remove a word from the trie.

trie.removeWord("name3");

Get All Words

List all words in the word list.

trie.getWords()

Get Prefix

Search the trie for all words that begin with or match a given string. Returns an array of found strings.

trie.getPrefix("jo")

Export Trie Index

let exported = trie.getIndex();

Import Trie Index

trie.setIndex(indexJSON);

changelog

[0.0.4] 3-30-2018

  • You can now export and import Trie indexes.

[0.0.3] 12-23-2017

  • Empty array is no longer required to initilize a new trie object.

[0.0.2] 4-17-2017

  • Restored getWords method.

[0.0.1] 4-11-2017