Getting started

These pages target the unreleased v3 workspace. The current published v2 package has a different result format; see the migration guide.

Install

pnpm add modern-ahocorasick

Until v3 is published, run the examples against this repository's workspace build. Publishing and deployment are separate, explicit actions.

ESM and CommonJS

import AhoCorasick from 'modern-ahocorasick'

const ac = new AhoCorasick(['he', 'she', 'his', 'hers'])
const matches = ac.search('ushers')
// [
//   { pattern: 'she', patternIndex: 1, start: 1, end: 4, data: undefined },
//   { pattern: 'he', patternIndex: 0, start: 2, end: 4, data: undefined },
//   { pattern: 'hers', patternIndex: 3, start: 2, end: 6, data: undefined },
// ]

const AhoCorasick = require('modern-ahocorasick')

const ac = new AhoCorasick(['he'])
console.log(ac.match('ushers')) // true

CommonJS returns the constructor directly. TypeScript declarations require TypeScript 5.3 or newer. The runtime requires Intl.Segmenter; development tooling requires Node 22.22.1+, 24.11+, or 26+, with pnpm 12.5.1.

Develop this site

pnpm install --frozen-lockfile
pnpm docs:dev
pnpm docs:build
pnpm docs:preview

The development command builds the workspace library first. Preview serves the static output after a build. No backend, account, or deployment configuration is needed.

Continue with the API or open the visualizer.