Class Text

Returns Text

Returns Char[]

a one dimensional array of Chars

const text: Text = new Text("יָד");
text.chars;
//  [
//    Char { original: "י" },
//    Char { original: "ָ" },
//    Char { original: "ד" }
//  ]
Copy

Returns Cluster[]

a one dimensional array of Clusters

const text: Text = new Text("יָד");
text.clusters;
// [
//    Cluster { original: "יָ" },
//    Cluster { original: "ד" }
//  ]
Copy

Returns string

the original string passed

const text: Text = new Text("הֲבָרֹות");
text.original;
// "הֲבָרֹות"
Copy

Returns Syllable[]

a one dimensional array of Syllables

const text: Text = new Text("הֲבָרֹות");
text.syllables;
// [
//    Syllable { original: "הֲ" },
//    Syllable { original: "בָ" },
//    Syllable { original: "רֹות" }
//  ]
Copy

Returns string

a string that has been decomposed, sequenced, qamets qatan patterns converted to the appropriate unicode character (U+05C7), and holem-waw sequences corrected

import { Text } from "havarotjs";
const text: Text = new Text("וַתָּשָׁב");
text.text;
// וַתָּשׇׁב
Copy

Returns Word[]

a one dimensional array of Words

const text: Text = new Text("הֲבָרֹות");
text.words;
// [Word { original: "הֲבָרֹות" }]
Copy