Class Soundex

Protected Readonlymap

Protected Readonlyoptions

Protected ReadonlyoptKey

ProtectedapplyPattern

• applyPattern(word: string): string

  Applies patterns to a word based on the phonetic map.

  This method processes the word by applying all defined patterns in the phonetic map. It replaces occurrences of specified patterns with their corresponding replacements.

  Parameters

  • word: string

    The input word to be processed

  Returns string

  • The modified word after applying all patterns

ProtectedapplyRules

• applyRules(
      char: string,
      i: number,
      chars: string[],
      charLen: number,
  ): string | undefined

  Applies phonetic rules to a character in a word context.

  This method is designed to be generic and efficient for all phonetic algorithms. It checks all rule types (prev, next, prevNot, nextNot, position, etc.) and returns either the appropriate code (string) or undefined.

  Parameters

  • char: string

    The current character

  • i: number

    The current position within the word

  • chars: string[]

    The word as an array of characters

  • charLen: number

    The total length of the word

  Returns string | undefined

  • The rule code or undefined if no rule applies

Protectedencode

• encode(word: string): string

  Generates the phonetic code for a given word.

  This method processes the word character by character, applying phonetic rules and mappings to generate a phonetic code.

  Parameters

  • word: string

    The input word to be converted into a phonetic code

  Returns string

  • The generated phonetic code

ProtectedequalLen

• equalLen(input: string): string

  Ensures the phonetic code has a fixed length by padding or truncating.

  Parameters

  • input: string

    The input string to be adjusted

  Returns string

  • The adjusted string with fixed length

ProtectedexitEarly

• exitEarly(code: string, i: number): boolean

  Determines whether to exit early based on the current phonetic code length.

  Parameters

  • code: string

    The current phonetic code

  • i: number

    The current index in the word

  Returns boolean

  • True if the code length exceeds the specified limit, false otherwise

Protectedloop

• loop(words: string[]): string[]

  Processes an array of words to generate their phonetic indices.

  This method iterates over each word, generates its phonetic code, and ensures that the resulting codes are of equal length.

  Parameters

  • words: string[]

    An array of words to be processed

  Returns string[]

  • An array of phonetic indices for the input words

ProtectedloopAsync

• loopAsync(words: string[]): Promise<string[]>

  Asynchronously processes an array of words to generate their phonetic indices.

  This method iterates over each word, generates its phonetic code asynchronously, and ensures that the resulting codes are of equal length.

  Parameters

  • words: string[]

    An array of words to be processed

  Returns Promise<string[]>

  • A promise that resolves to an array of phonetic indices for the input words

ProtectedmapChar

• mapChar(
      char: string,
      i: number,
      chars: string[],
      charLen: number,
      lastCode: string | null,
      map: Record<string, string>,
  ): string | undefined

  Converts a character to its phonetic code based on the mapping and rules.

  Parameters

  • char: string

    The current character

  • i: number

    The current position within the word

  • chars: string[]

    The word as an array of characters

  • charLen: number

    The total length of the word

  • lastCode: string | null

    The last code generated (to avoid duplicates)

  • map: Record<string, string>

    The phonetic mapping

  Returns string | undefined

  • The phonetic code or undefined if no code applies

Protectedword2Chars

• word2Chars(word: string): string[]

  Converts a word into an array of characters.

  Parameters

  • word: string

    The input word to be converted

  Returns string[]

  • An array of characters from the input word