JSPM – @jimtkelly/aho-corasick@1.0.0

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jimtkelly/aho-corasick) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

aho-corasick

An implementation of the Aho-Corasick algorithm in TypeScript.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

Figure 1: Aho-Corasick Algorithm Diagram [1]

The Aho—Corasick algorithm is a string-searching algorithm invented by Alfred V. Aho and Margaret J. Corasick in 1975. [1]. This repository contains an implementation of this algorithm in TypeScript for use in efficient string matching as an aid to bibliographic searches.

This package is referenced and inspired from tanishiking's aho-corasick-js package, providing some minor improvements to optimisation and additional functionality.

(back to top)

Built With

(back to top)

Getting Started

Installation

To use this project, please install the required packages as available from npm.

npm
```
npm install @jamestkelly/aho-corasick
```

Usage

Create `Trie` and Add Keywords

It's important to note that if the param, keywords is an array of empty strings, e.g., [' ', ''], then an error will be thrown.

const trie = new Trie();
trie.addKeyword('apple');
trie.addKeyword('banana');

Get `Matches`

const trie = new Trie(['apple', 'banana']);
const matches = trie.getMatches('apple banana');
console.log(matches);
// Output: [{ start: 0, end: 4, keyword: 'apple' }, { start: 6, end: 11, keyword: 'banana' }]

Get Inverse `Matches`

const trie = new Trie(['cat', 'dog']);
const nonMatches = trie.getNonMatches('The cat and the dog');
console.log(nonMatches);
// Output: ['The ', ' and the ']

Get String Occurrences

const trie = new Trie(['apple', 'banana']);
const occurrences = trie.getStringOccurrences('apple banana apple');
console.log(occurrences);
// Output: [{ keyword: 'apple', occurrences: 2 }, { keyword: 'banana', occurrences: 1 }]

For more examples, please refer to the Documentation

(back to top)

Roadmap

Base implementation of the Aho-corasick algorithm.
Add GitHub workflow to test & build the package.
Implement feature to return non-matches, i.e., all words that did not match.
- Additional nice to have is to only return the words that matched and their counts, i.e., without position in the string.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!