remove

remove(text, options): string

Removes niqqud from Hebrew text

Parameters

Parameter	Type	Description
text	string	a string of Hebrew characters
options	RemoveOptions

Returns

string

Hebrew characters with accents and niqqud optionally removed

Examples

Default

// by default removes all accents and metheg and rafe
remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ");
// שָׂרַי אִשְׁתְּךָ, וַיִּמְצְאוּ

Remove accents and vowels, but not shin/sin dots

import { accents, vowels } from "hebrew-transliteration/removeOptions";

remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", { ...accents, ...vowels, METEG: true });
// שׂרי אשׁתך, וימצאו

Remove all

import { all } from "hebrew-transliteration/removeOptions";

remove("שָׂרַ֣י אִשְׁתְּךָ֔, וַֽיִּמְצְא֗וּ", all);
// שרי אשתך, וימצאו

Defined in

src/remove.ts:578