Overview The buildTrie function constructs a trie data structure from an array of rules. This trie is used to efficiently search through text and replace specified source words with their corresponding target words.
Function signature buildTrie ( rules : Rule [], buildOptions ?: BuildTrieOptions ): TrieNode
Parameters Array of search and replace rules to build the trie from. Each rule contains: Array of source strings to search for in the text
Target string to replace the matched source words with
Optional configuration for rule behavior:
match: Specifies matching context (MatchType.Whole, MatchType.Alone, or MatchType.Any)casing: Controls case sensitivity (CaseSensitivity.Insensitive or CaseSensitivity.Sensitive)prefix: String to add before the replacement if absent in textclipStartPattern: Pattern to trim characters before the matchclipEndPattern: Pattern to trim characters after the matchconfirm: Conditions that must be met for the rule to apply Optional build configuration: Show BuildTrieOptions properties
When true, treats all apostrophe-like characters as equivalent during matching. This allows a rule with “don’t” to match variants like “don’t”, “don`t”, etc. Normalization is applied to rule sources during build time and to input text during search time.
Returns The constructed trie with build options stored for use during search operations. The root node of the trie data structure represents the rules for search and replacement.
Example usage Basic usage import { buildTrie } from 'trie-rules' ; const rules = [ { from: [ 'example' , 'sample' ], to: 'demo' , }, { from: [ 'specificword' ], to: 'replacement' , options: { match: MatchType . Whole , }, }, ]; const trie = buildTrie ( rules );
With apostrophe normalization import { buildTrie , MatchType } from 'trie-rules' ; const rules = [ { from: [ "al-Qur'an" ], to: 'al-Qurʾān' , options: { match: MatchType . Whole , }, }, { from: [ "Ka'bah" ], to: 'Kaʿbah' , }, ]; // Build trie with apostrophe normalization enabled const trie = buildTrie ( rules , { normalizeApostrophes: true }); // The trie can now match "al-Qur'an", "al-Qur`an", etc.
With case-insensitive matching import { buildTrie , CaseSensitivity } from 'trie-rules' ; const rules = [ { from: [ 'testword' ], to: 'tested' , options: { casing: CaseSensitivity . Insensitive , }, }, ]; const trie = buildTrie ( rules ); // Will match 'testword', 'TestWord', 'TESTWORD', etc.
Implementation details The function processes each rule by:
Applying apostrophe normalization if enabled
Generating case variants for case-insensitive rules
Inserting each source string into the trie structure
Storing build options at the root for use during search operations
Runtime complexity The complexity is O(n · m · k) where:
n = number of rulesm = average number of source words per rulek = average length of source words
This represents the total number of characters across all source words in all rules.