cmpstr-cli/dist/commands/index.d.ts

Simple CLI wrapper for the CmpStr package to normalize and compare strings directly via terminal

/**
 * @fileoverview
 * Index command for CmpStr CLI.
 *
 * Computes the phonetic representation of the given input string using
 * the selected algorithm and options. Supports both synchronous and
 * asynchronous processing.
 *
 * @author Paul Köhler (komed3)
 * @license MIT
 */
import { type Command } from 'commander';
/**
 * Computes the phonetic representation of the given input string.
 *
 * @async
 * @param {string} input - The input string or file path.
 * @param {Record< string, any >} [opt] - Phonetic options.
 * @param {Command} cmd - The Commander command instance.
 */
export declare function index(input: string, opt: Record<string, any> | undefined, cmd: Command): Promise<void>;