RemoveOptions

Options for removing characters from Hebrew text, divided into categories

Other

ON_COMPLETE?

optional ON_COMPLETE?: (result, context) => string

A callback that is invoked when removal is complete

Parameters

Parameter	Type
`result`	`string`
`context`	{ `options`: `RemoveOptions`; `original`: `string`; }
`context.options`	`RemoveOptions`
`context.original`	`string`

Returns

string

Examples

Modifying the result

import { remove, accents } from "hebrew-transliteration";

remove("שָׂרַ֣י אִשְׁתְּךָ֔", {
  ...accents,
  ON_COMPLETE: (result) => result.replace("ת", "t"),
});
// "שׂרי אשתכ"

Accessing callback arguments

import { remove, accents } from "hebrew-transliteration";

remove("שָׂרַ֣י אִשְׁתְּךָ֔", {
  ...accents,
  ON_COMPLETE: (result, { original, options }) => {
    console.log("Original Hebrew:", original);
    console.log("Options used:", options);
    return result;
  },
});
// Original Hebrew: שָׂרַ֣י אִשְׁתְּךָ֔
// Options used: { ETNAHTA: true, ... }

Punctuation

LOWER_DOT?

optional LOWER_DOT?: boolean

Defined in: src/remove.ts:367

HEBREW MARK LOWER DOT (U+05C5) ◌ׅ

MAQAF?

optional MAQAF?: boolean

Defined in: src/remove.ts:308

HEBREW PUNCTUATION MAQAF (U+05BE) ־◌

Remarks

Unlike other characters, this is replaced with a space instead of being removed.

MASORA_CIRCLE?

optional MASORA_CIRCLE?: boolean

Defined in: src/remove.ts:353

HEBREW MARK MASORA CIRCLE (U+05AF) ◌֯

NUN_HAFUKHA?

optional NUN_HAFUKHA?: boolean

Defined in: src/remove.ts:326

HEBREW PUNCTUATION NUN HAFUKHA (U+05C6) ׆

PASEQ?

optional PASEQ?: boolean

Defined in: src/remove.ts:314

HEBREW PUNCTUATION PASEQ (U+05C0) ׀ ◌

PUNC_GERESH?

optional PUNC_GERESH?: boolean

Defined in: src/remove.ts:336

HEBREW PUNCTUATION GERESH (U+05F3) ׳◌

Remarks

Distinguished from GERESH (U+059C). This character is mostly used in Modern Hebrew, but could be used in place of the other.

PUNC_GERSHAYIM?

optional PUNC_GERSHAYIM?: boolean

Defined in: src/remove.ts:346

HEBREW PUNCTUATION GERSHAYIM (U+05F4) ״◌

Remarks

Distinguished from GERSHAYIM (U+059E). This character is mostly used in Modern Hebrew, but could be used in place of the other.

SOF_PASUQ?

optional SOF_PASUQ?: boolean

Defined in: src/remove.ts:320

HEBREW PUNCTUATION SOF PASUQ (U+05C3) ׃◌

UPPER_DOT?

optional UPPER_DOT?: boolean

Defined in: src/remove.ts:360

HEBREW MARK UPPER DOT (U+05C4) ◌ׄ

Taamim

ATNAH_HAFUKH?

optional ATNAH_HAFUKH?: boolean

Defined in: src/remove.ts:125

HEBREW ACCENT ATNAH HAFUKH (U+05A2) ◌֢

DARGA?

optional DARGA?: boolean

Defined in: src/remove.ts:155

HEBREW ACCENT DARGA (U+05A7) ◌֧

DEHI?

optional DEHI?: boolean

Defined in: src/remove.ts:191

HEBREW ACCENT DEHI (U+05AD) ◌֭

ETNAHTA?

optional ETNAHTA?: boolean

Defined in: src/remove.ts:23

HEBREW ACCENT ETNAHTA (U+0591) ◌֑

GERESH?

optional GERESH?: boolean

Defined in: src/remove.ts:89

HEBREW ACCENT GERESH (U+059C) ◌֜

GERESH_MUQDAM?

optional GERESH_MUQDAM?: boolean

Defined in: src/remove.ts:95

HEBREW ACCENT GERESH MUQDAM (U+059D) ◌֝

GERSHAYIM?

optional GERSHAYIM?: boolean

Defined in: src/remove.ts:101

HEBREW ACCENT GERSHAYIM (U+059E) ◌֞

ILUY?

optional ILUY?: boolean

Defined in: src/remove.ts:185

HEBREW ACCENT ILUY (U+05AC) ◌֬

LOWER_DOT?

optional LOWER_DOT?: boolean

Defined in: src/remove.ts:367

HEBREW MARK LOWER DOT (U+05C5) ◌ׅ

MAHAPAKH?

optional MAHAPAKH?: boolean

Defined in: src/remove.ts:137

HEBREW ACCENT MAHAPAKH (U+05A4) ◌֤

MASORA_CIRCLE?

optional MASORA_CIRCLE?: boolean

Defined in: src/remove.ts:353

HEBREW MARK MASORA CIRCLE (U+05AF) ◌֯

MERKHA?

optional MERKHA?: boolean

Defined in: src/remove.ts:143

HEBREW ACCENT MERKHA (U+05A5) ◌֥

MERKHA_KEFULA?

optional MERKHA_KEFULA?: boolean

Defined in: src/remove.ts:149

HEBREW ACCENT MERKHA KEFULA (U+05A6) ◌֦

MUNAH?

optional MUNAH?: boolean

Defined in: src/remove.ts:131

HEBREW ACCENT MUNAH (U+05A3) ◌֣

OLE?

optional OLE?: boolean

Defined in: src/remove.ts:179

HEBREW ACCENT OLE (U+05AB) ◌֫

PASHTA?

optional PASHTA?: boolean

Defined in: src/remove.ts:71

HEBREW ACCENT PASHTA (U+0599) ◌֙

PAZER?

optional PAZER?: boolean

Defined in: src/remove.ts:119

HEBREW ACCENT PAZER (U+05A1) ◌֡

PUNC_GERESH?

optional PUNC_GERESH?: boolean

Defined in: src/remove.ts:336

HEBREW PUNCTUATION GERESH (U+05F3) ׳◌

Remarks

Distinguished from GERESH (U+059C). This character is mostly used in Modern Hebrew, but could be used in place of the other.

PUNC_GERSHAYIM?

optional PUNC_GERSHAYIM?: boolean

Defined in: src/remove.ts:346

HEBREW PUNCTUATION GERSHAYIM (U+05F4) ״◌

Remarks

Distinguished from GERSHAYIM (U+059E). This character is mostly used in Modern Hebrew, but could be used in place of the other.

QADMA?

optional QADMA?: boolean

Defined in: src/remove.ts:161

HEBREW ACCENT QADMA (U+05A8) ◌֨

QARNEY_PARA?

optional QARNEY_PARA?: boolean

Defined in: src/remove.ts:107

HEBREW ACCENT QARNEY PARA (U+059F) ◌֟

REVIA?

optional REVIA?: boolean

Defined in: src/remove.ts:59

HEBREW ACCENT REVIA (U+0597) ◌֗

SEGOLTA?

optional SEGOLTA?: boolean

Defined in: src/remove.ts:29

HEBREW ACCENT SEGOL (U+0592) ◌֒

SHALSHELET?

optional SHALSHELET?: boolean

Defined in: src/remove.ts:35

HEBREW ACCENT SHALSHELET (U+0593) ◌֓

TELISHA_GEDOLA?

optional TELISHA_GEDOLA?: boolean

Defined in: src/remove.ts:113

HEBREW ACCENT TELISHA GEDOLA (U+05A0) ◌֠

TELISHA_QETANA?

optional TELISHA_QETANA?: boolean

Defined in: src/remove.ts:167

HEBREW ACCENT TELISHA QETANA (U+05A9) ◌֩

TEVIR?

optional TEVIR?: boolean

Defined in: src/remove.ts:83

HEBREW ACCENT TEVIR (U+059B) ◌֛

TIPEHA?

optional TIPEHA?: boolean

Defined in: src/remove.ts:53

HEBREW ACCENT TIPEHA (U+0596) ◌֖

UPPER_DOT?

optional UPPER_DOT?: boolean

Defined in: src/remove.ts:360

HEBREW MARK UPPER DOT (U+05C4) ◌ׄ

YERAH_BEN_YOMO?

optional YERAH_BEN_YOMO?: boolean

Defined in: src/remove.ts:173

HEBREW ACCENT YERAH BEN YOMO (U+05AA) ◌֪

YETIV?

optional YETIV?: boolean

Defined in: src/remove.ts:77

HEBREW ACCENT YETIV (U+059A) ◌֚

ZAQEF_GADOL?

optional ZAQEF_GADOL?: boolean

Defined in: src/remove.ts:47

HEBREW ACCENT ZAQEF GADOL (U+0595) ◌֕

ZAQEF_QATAN?

optional ZAQEF_QATAN?: boolean

Defined in: src/remove.ts:41

HEBREW ACCENT ZAQEF QATAN (U+0594) ◌֔

ZARQA?

optional ZARQA?: boolean

Defined in: src/remove.ts:65

HEBREW ACCENT ZARQA (U+0598) ◌֘

ZINOR?

optional ZINOR?: boolean

Defined in: src/remove.ts:197

HEBREW ACCENT ZINOR (U+05AE) ◌֮

Vowels

DAGESH?

optional DAGESH?: boolean

Defined in: src/remove.ts:269

HEBREW POINT DAGESH OR MAPIQ (U+05BC) ◌ּ

HATAF_PATAH?

optional HATAF_PATAH?: boolean

Defined in: src/remove.ts:215

HEBREW POINT HATAF PATAH (U+05B2) ◌ֲ

HATAF_QAMATS?

optional HATAF_QAMATS?: boolean

Defined in: src/remove.ts:221

HEBREW POINT HATAF QAMATS (U+05B3) ◌ֳ

HATAF_SEGOL?

optional HATAF_SEGOL?: boolean

Defined in: src/remove.ts:209

HEBREW POINT HATAF SEGOL (U+05B1) ◌ֱ

HIRIQ?

optional HIRIQ?: boolean

Defined in: src/remove.ts:227

HEBREW POINT HIRIQ (U+05B4) ◌ִ

HOLAM?

optional HOLAM?: boolean

Defined in: src/remove.ts:257

HEBREW POINT HOLAM (U+05B9) ◌ֹ

METEG?

optional METEG?: boolean

Defined in: src/remove.ts:275

HEBREW POINT METEG (U+05BD) ◌ֽ

PATAH?

optional PATAH?: boolean

Defined in: src/remove.ts:245

HEBREW POINT PATAH (U+05B7) ◌ַ

QAMATS?

optional QAMATS?: boolean

Defined in: src/remove.ts:251

HEBREW POINT QAMATS (U+05B8) ◌ָ

QAMATS_QATAN?

optional QAMATS_QATAN?: boolean

Defined in: src/remove.ts:299

HEBREW POINT QAMATS QATAN (U+05C7) ◌ׇ

QUBUTS?

optional QUBUTS?: boolean

Defined in: src/remove.ts:263

HEBREW POINT QUBUTS (U+05BB) ◌ֻ

RAFE?

optional RAFE?: boolean

Defined in: src/remove.ts:281

HEBREW POINT RAFE (U+05BF) ◌ֿ

SEGOL?

optional SEGOL?: boolean

Defined in: src/remove.ts:239

HEBREW POINT SEGOL (U+05B6) ◌ֶ

SHEVA?

optional SHEVA?: boolean

Defined in: src/remove.ts:203

HEBREW POINT SHEVA (U+05B0) ◌ְ

SHIN_DOT?

optional SHIN_DOT?: boolean

Defined in: src/remove.ts:287

HEBREW POINT SHIN DOT (U+05C1) ◌ׁ

SIN_DOT?

optional SIN_DOT?: boolean

Defined in: src/remove.ts:293

HEBREW POINT SIN DOT (U+05C2) ◌ׂ

TSERE?

optional TSERE?: boolean

Defined in: src/remove.ts:233

HEBREW POINT TSERE (U+05B5) ◌ֵ