Class Char

Returns Char

const text: Text = new Text("אֱלֹהִ֑ים");
text.chars[0].characterName;
// "ALEF"
Copy

Returns null | "ETNAHTA" | "SEGOL_ACCENT" | "SHALSHELET" | "ZAQEF_QATAN" | "ZAQEF_GADOL" | "TIPEHA" | "REVIA" | "ZARQA" | "PASHTA" | "YETIV" | "TEVIR" | "GERESH" | "GERESH_MUQDAM" | "GERSHAYIM" | "QARNEY_PARA" | "TELISHA_GEDOLA" | "PAZER" | "ATNAH_HAFUKH" | "MUNAH" | "MAHAPAKH" | "MERKHA" | "MERKHA_KEFULA" | "DARGA" | "QADMA" | "TELISHA_QETANA" | "YERAH_BEN_YOMO" | "OLE" | "ILUY" | "DEHI" | "ZINOR" | "HATAF_SEGOL" | "HATAF_PATAH" | "HATAF_QAMATS" | "HIRIQ" | "TSERE" | "SEGOL" | "PATAH" | "QAMATS" | "HOLAM" | "HOLAM_HASER" | "QUBUTS" | "QAMATS_QATAN" | "ALEF" | "BET" | "GIMEL" | "DALET" | "HE" | "VAV" | "ZAYIN" | "HET" | "TET" | "YOD" | "FINAL_KAF" | "KAF" | "LAMED" | "FINAL_MEM" | "MEM" | "FINAL_NUN" | "NUN" | "SAMEKH" | "AYIN" | "FINAL_PE" | "PE" | "FINAL_TSADI" | "TSADI" | "QOF" | "RESH" | "SHIN" | "TAV" | "SHEVA" | "DAGESH" | "RAFE" | "MAQAF" | "PASEQ" | "SOF_PASUQ" | "NUN_HAFUKHA" | "GERESH_PUNCTUATION" | "GERSHAYIM_PUNCTUATION" | "SHIN_DOT" | "SIN_DOT" | "MASORA_CIRCLE" | "UPPER_DOT" | "LOWER_DOT" | "YOD_TRIANGLE" | "DOUBLE_VAV" | "VAV_YOD" | "DOUBLE_YOD"

const text: Text = new Text("דָּבָר");
const firstChar = text.chars[0];
firstChar.text;
// "ד"
firstChar.cluster?.text;
// "דָּ"
Copy

Returns null | Cluster

Returns void

const text: Text = new Text("אֱלֹהִ֑ים");
text.chars[0].isConsonant;
// true
Copy

Returns boolean

const text: Text = new Text("בּ");
text.chars[1].isDagesh;
// true
Copy

Returns boolean

const text: Text = new Text("שָׁלֽוֹם");
text.chars[1].isLigature;
// true
Copy

Returns boolean

const text: Text = new Text("a");
text.chars[0].isNotHebrew;
// true
Copy

Returns boolean

const text: Text = new Text("בֿ");
text.chars[1].isRafe;
// true
Copy

Returns boolean

const text: Text = new Text("בְ");
text.chars[1].isSheva;
// true
Copy

Returns boolean

const text: Text = new Text("בֺ֨");
text.chars[2].isTaamim;
// true
Copy

Returns boolean

const text: Text = new Text("בֺ");
text.chars[1].isVowel;
// true
Copy

Returns boolean

Returns number

a number used for sequencing

• consonants = 0
• ligatures = 1
• dagesh or rafe = 2
• niqqud (i.e vowels) = 3
• taamim (i.e. accents) = 4

const text: Text = new Text("אֱלֹהִ֑ים");
text.chars[0].sequencePosition; // the aleph
// 0
text.chars[1].sequencePosition; // the segol
// 3
Copy

Returns string

the text of the Char

const text: Text = new Text("אֱלֹהִ֑ים");
text.chars[0].text;
// "א"
Copy

Returns boolean