Installation

​

Install the package

npm install trie-rules

​

Package details

• Package name: trie-rules
• License: MIT
• Repository: github.com/ragaeeb/trie-rules
• Bundle size: View detailed bundle analysis at bundlejs.com

​

Requirements

​

Verify installation

import { buildTrie, searchAndReplace } from 'trie-rules';

console.log(typeof buildTrie); // 'function'
console.log(typeof searchAndReplace); // 'function'

​

What’s included

​

Core functions

• buildTrie - Constructs a trie from an array of rules
• searchAndReplace - Performs search and replace operations using a trie
• containsSource - Checks if a source string exists in the trie
• containsTarget - Checks if a target string exists in the trie
• optimizeRules - Optimizes and consolidates redundant rules

​

Types and enums

• Rule - Type definition for search and replace rules
• TrieNode - Type definition for trie data structure
• BuildTrieOptions - Configuration options for building tries
• SearchAndReplaceOptions - Configuration options for search operations
• CaseSensitivity - Enum for case matching behavior
• MatchType - Enum for match context requirements
• TriePattern - Enum for predefined clipping patterns

​

Utility functions

• adjustCasing - Adjusts replacement casing based on source
• findFirstAlphaIndex - Finds the first alphabetic character index
• generateCaseVariants - Generates case variants for a string
• isAlphabeticLetter - Checks if a character is alphabetic
• isLetter - Checks if a character is a letter
• isLowerCase - Checks if a character is lowercase
• isUpperCase - Checks if a character is uppercase
• isWordCharacterAt - Checks if character at position is a word character

​

Constants

• APOSTROPHE_LIKE_REGEX - Regular expression matching apostrophe-like characters
• LETTER_REGEX - Regular expression matching any Unicode letter

​

Next steps