unniqqud/dist/index.d.ts

Remove niqqud (Hebrew vowel diacritics) and/or Ta'amim (Hebrew cantillation diacritics) from text.

/**
 * @returns true if the given character is a diacritic character (either niqqud or cantillation).
 */
export declare function diacritic(charCode: string): boolean;
/**
 * @returns true if the given character is a niqqud (vowel diacritic) character.
 */
export declare function niqqud(charCode: string): boolean;
/**
 * @returns true if the given character is a ta'am (cantillation diacritic) character.
 */
export declare function taam(charCode: string): boolean;
/**
 * Removes diacritics from the given string.
 * @param input The input string.
 * @param type The type of diacritics to remove. Must be one of:
 * - {@link diacritic}: removes all diacritics (default).
 * - {@link niqqud}: removes all niqqud diacritics.
 * - {@link taam}: removes all ta'am diacritics.
 * @returns The input string with the desired diacritics removed.
 */
declare function string(input: string, type?: (charCode: string) => boolean): string;
export default string;