Word

Defined in: word.ts:13

A subunit of a Text consisting of words, which are strings are text separated by spaces or maqqefs.

Extends

Node<Word, Text>

Constructors

Constructor

new Word(text, sylOpts, original?): Word

Defined in: word.ts:81

Parameters

Parameter	Type
`text`	`string`
`sylOpts`	`SylOpts`
`original?`	`string`

Returns

Word

Overrides

Node.constructor

Properties

children

children: Node<Text, any, any>[] | null = null

Defined in: node.ts:21

Collection of child nodes.

Inherited from

Node.children

next: Node<Word, null, null> | null = null

Defined in: node.ts:11

Next sibling in the sequence.

Inherited from

Node.next

parent

parent: Node<null, any, any> | null = null

Defined in: node.ts:18

Reference to the parent container.

Inherited from

Node.parent

prev: Node<Word, null, null> | null = null

Defined in: node.ts:13

Previous sibling in the sequence.

Inherited from

Node.prev

value

value: Word | null = null

Defined in: node.ts:15

Node data.

Inherited from

Node.value

whiteSpaceAfter

whiteSpaceAfter: string | null

Defined in: word.ts:77

The white space that appears after the word

Returns

any white space that appears after the word such as a space or new line

Example

const heb = `
עֶבֶד
אֱלֹהִים
`;
const text = new Text(heb);
text.words;
// [
//   Word {
//     original: 'עֶבֶד\n',
//     text: 'עֶבֶד',
//     whiteSpaceBefore: '',
//     whiteSpaceAfter: '\n'
//   },
//   Word {
//     original: 'אֱלֹהִים',
//     text: 'אֱלֹהִים',
//     whiteSpaceBefore: '',
//     whiteSpaceAfter: ''
//   }
// ]

whiteSpaceBefore

whiteSpaceBefore: string | null

Defined in: word.ts:47

The white space that appears before the word

Returns

any white space that appears before the word such as a space or new line

Example

const heb = `
עֶבֶד
אֱלֹהִים
`;
const text = new Text(heb);
text.words;
// [
//   Word {
//     original: 'עֶבֶד\n',
//     text: 'עֶבֶד',
//     whiteSpaceBefore: '',
//     whiteSpaceAfter: '\n'
//   },
//   Word {
//     original: 'אֱלֹהִים',
//     text: 'אֱלֹהִים',
//     whiteSpaceBefore: '',
//     whiteSpaceAfter: ''
//   }
// ]

Accessors

chars

Get Signature

get chars(): Char[]

Defined in: word.ts:140

Gets all the Characters in the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
text.words[0].chars;
// [
//    Char { original: "א" },
//    Char { original: "ֵ" }, (tsere)
//    Char { original: "פ" },
//    Char { original: "ֹ" }, (holem)
//    Char { original: "ה"},
//    Char { original: "־" }
//  ]

Returns

Char[]

a one dimensional array of Chars

clusters

Get Signature

get clusters(): Cluster[]

Defined in: word.ts:161

Gets all the Clusters in the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
text.words[0].clusters;
// [
//    Cluster { original: "אֵ" },
//    Cluster { original: "י" },
//    Cluster { original: "פֹ" },
//    Cluster { original: "ה־" }
//  ]

Returns

Cluster[]

a one dimensional array of Clusters

consonantNames

Get Signature

get consonantNames(): ("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")[]

Defined in: word.ts:197

Gets all the consonant character names in the Word

Example

const text = new Text("הָאָ֖רֶץ");
text.words[0].consonantNames;
// ["HE", "ALEF", "RESH", "FINAL_TSADI"]

Returns

("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")[]

a one dimensional array of all the consonant character names in the Word

consonants

Get Signature

get consonants(): ("א" | "ב" | "ג" | "ד" | "ה" | "ו" | "ז" | "ח" | "ט" | "י" | "ך" | "כ" | "ל" | "ם" | "מ" | "ן" | "נ" | "ס" | "ע" | "ף" | "פ" | "ץ" | "צ" | "ק" | "ר" | "ש" | "ת")[]

Defined in: word.ts:181

Gets all the consonant characters in the Word

Example

const text = new Text("הָאָ֖רֶץ");
text.words[0].consonants;
// ["ה", "א", "ר", "ץ"]

Returns

("א" | "ב" | "ג" | "ד" | "ה" | "ו" | "ז" | "ח" | "ט" | "י" | "ך" | "כ" | "ל" | "ם" | "מ" | "ן" | "נ" | "ס" | "ע" | "ף" | "פ" | "ץ" | "צ" | "ק" | "ר" | "ש" | "ת")[]

a one dimensional array of all the consonant characters in the Word

hasDivineName

Get Signature

get hasDivineName(): boolean

Defined in: word.ts:234

Checks if the word has a form of the Divine Name (i.e the tetragrammaton)

Example

const text = new Text("בַּֽיהוָ֔ה");
text.words[0].hasDivineName;
// true

Returns

boolean

a boolean indicating if the word has a form of the Divine Name

isDivineName

Get Signature

get isDivineName(): boolean

Defined in: word.ts:300

Checks if the text is a form of the Divine Name (i.e the tetragrammaton)

Example

const text = new Text("יְהוָה");
text.words[0].isDivineName;
// true

Returns

boolean

a boolean indicating if the text is a form of the Divine Name

isInConstruct

Get Signature

get isInConstruct(): boolean

Defined in: word.ts:338

Checks if the Word is in a construct state

Example

const text = new Text("בֶּן־אָדָ֕ם");
text.words[0].isInConstruct;
// true

Remarks

The construct state is indicated by the presence of a maqqef (U+05BE) character

Returns

boolean

a boolean indicating if the Word is in a construct state

isNotHebrew

Get Signature

get isNotHebrew(): boolean

Defined in: word.ts:319

Checks if the Word contains non-Hebrew characters

Example

const text = new Text("Hi!");
text.words[0].isNotHebrew;
// true

Remarks

If the word contains non-Hebrew characters, it is not considered Hebrew because syllabification is likely not correct.

Returns

boolean

a boolean indicating if the Word contains non-Hebrew characters

original

Get Signature

get original(): string

Defined in: word.ts:373

The original string passed

Remarks

The original string passed to the constructor still undergoes the normalization and sequence process, just not checked against any KetivQeres.

Returns

string

the original string passed

siblings

Get Signature

get siblings(): Node<Self, Child, any>[]

Defined in: node.ts:45

Retrieves all subsequent nodes in the current sibling chain.

Returns

Node<Self, Child, any>[]

Set Signature

set siblings(arr): void

Defined in: node.ts:29

Connects an array of nodes as a doubly-linked sibling chain starting after this node.

Parameters

Parameter	Type
`arr`	`Node`<`Self`, `Child`, `any`>[]

Returns

void

Inherited from

Node.siblings

syllables

Get Signature

get syllables(): Syllable[]

Defined in: word.ts:392

Gets all the Syllables in the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
text.words[0].syllables;
// [
//    Syllable { original: "אֵי" },
//    Syllable { original: "פֹה־" }
//  ]

Returns

Syllable[]

a one dimensional array of Syllables

taamim

Get Signature

get taamim(): ("֑" | "֒" | "֓" | "֔" | "֕" | "֖" | "֗" | "֘" | "֙" | "֚" | "֛" | "֜" | "֝" | "֞" | "֟" | "֠" | "֡" | "֢" | "֣" | "֤" | "֥" | "֦" | "֧" | "֨" | "֩" | "֪" | "֫" | "֬" | "֭" | "֮")[]

Defined in: word.ts:437

Gets all the taamim characters in the Word

Example

const text = new Text("הָאָ֖רֶץ");
text.words[0].taamim;
// ["\u{596}"];

Returns

("֑" | "֒" | "֓" | "֔" | "֕" | "֖" | "֗" | "֘" | "֙" | "֚" | "֛" | "֜" | "֝" | "֞" | "֟" | "֠" | "֡" | "֢" | "֣" | "֤" | "֥" | "֦" | "֧" | "֨" | "֩" | "֪" | "֫" | "֬" | "֭" | "֮")[]

a one dimensional array of all the taamim characters in the Word

taamimNames

Get Signature

get taamimNames(): ("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")[]

Defined in: word.ts:453

Gets all the taamim names in the Word

Example

const text = new Text("הָאָ֖רֶץ");
text.words[0].taamimNames;
// ["TIPEHA"];

Returns

a one dimensional array of all the taamim names in the Word

text

Get Signature

get text(): string

Defined in: word.ts:474

Gets the text of the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
const words = text.words.map((word) => word.text);
words;
// [
//    "אֵיפֹה־",
//    "אַתָּה",
//    "מֹשֶׁה"
//  ]

Returns

string

the word’s text trimmed of any whitespace characters

vowelNames

Get Signature

get vowelNames(): ("HATAF_SEGOL" | "HATAF_PATAH" | "HATAF_QAMATS" | "HIRIQ" | "TSERE" | "SEGOL" | "PATAH" | "QAMATS" | "HOLAM" | "HOLAM_HASER" | "QUBUTS" | "QAMATS_QATAN" | "SHEVA" | "SHUREQ")[]

Defined in: word.ts:490

Gets all the vowel names in the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
text.words[0].vowelNames;
// ["HOLAM", "SEGOL"];

Returns

an array of all the vowel names in the Word

vowels

Get Signature

get vowels(): ("ֱ" | "ֲ" | "ֳ" | "ִ" | "ֵ" | "ֶ" | "ַ" | "ָ" | "ֹ" | "ֺ" | "ֻ" | "ׇ" | "ְ" | "וּ")[]

Defined in: word.ts:506

Gets all the vowel characters in the Word

Example

const text = new Text("אֵיפֹה־אַתָּה מֹשֶה");
text.words[0].vowels;
// ["\u{5B9}", "\u{5B6}"];

Returns

("ֱ" | "ֲ" | "ֳ" | "ִ" | "ֵ" | "ֶ" | "ַ" | "ָ" | "ֹ" | "ֺ" | "ֻ" | "ׇ" | "ְ" | "וּ")[]

an array of all the vowel characters in the Word

Methods

hasConsonantName()

hasConsonantName(name): boolean

Defined in: word.ts:218

Checks if the word contains the consonant character of the name passed in

Parameters

Parameter	Type
`name`	`"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"`

Returns

boolean

a boolean indicating if the word contains the consonant character of the name passed in

Example

const text = new Text("הָאָ֖רֶץ");
text.words[0].hasConsonantName("HE");
// true
text.words[0].hasConsonantName("MEM");
// false

Remarks

This checks if the syllable contains the given consonant name, even if the character is not a phonemic consonant (i.e a mater).

hasTaamName()

hasTaamName(name): boolean

Defined in: word.ts:254

Checks if the word contains the taamim character of the name passed in

Parameters

Parameter Type

Parameter	Type
`name`	`"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"`

Returns

boolean

a boolean indicating if the word contains the taamim character of the name passed in

Example

const text = new Text("הָאָ֖רֶץ");
text.word[0].hasTaamName("TIPEHA");
// true

Remarks

Note: it only checks according to the character name, not its semantic meaning. E.g. “כֵֽן׃” would be true when checking for "METEG", not silluq

hasVowelName()

hasVowelName(name): boolean

Defined in: word.ts:284

Checks if the word contains the vowel character of the name passed in

Parameters

Parameter	Type
`name`	`"HATAF_SEGOL"` \| `"HATAF_PATAH"` \| `"HATAF_QAMATS"` \| `"HIRIQ"` \| `"TSERE"` \| `"SEGOL"` \| `"PATAH"` \| `"QAMATS"` \| `"HOLAM"` \| `"HOLAM_HASER"` \| `"QUBUTS"` \| `"QAMATS_QATAN"` \| `"SHEVA"` \| `"SHUREQ"`

Returns

boolean

a boolean indicating if the word contains the vowel character of the name passed in

Example

const text = new Text("הַיְחָבְרְךָ")'
text.word[0].hasVowelName("PATAH");
// true

// test for vocal sheva
text.word[0].hasVowelName("SHEVA");
// true

// test for silent sheva
text.word[0].hasVowelName("SHUREQ");
// false

Remarks

This returns a boolean if the vowel character is present, even for most mater lectionis (e.g. in a holam vav construction, “HOLAM” would return true). The only exception is a shureq, because there is no vowel character for a shureq. According to Syllabification, a sheva is a vowel and serves as the nucleus of a syllable. It returns true for “SHEVA” only when the sheva is the vowel (i.e. a vocal sheva or sheva na’).

isSyllableFinal()

isSyllableFinal(syllable): boolean

Defined in: word.ts:349

Checks if the syllable is the final syllable in the Word

Parameters

Parameter	Type	Description
`syllable`	`Syllable`	-

Returns

boolean

a boolean indicating if the syllable is the final syllable in the Word

isSyllableInitial()

isSyllableInitial(syllable): boolean

Defined in: word.ts:360

Checks if the syllable is the initial syllable in the Word

Parameters

Parameter	Type	Description
`syllable`	`Syllable`	-

Returns

boolean

a boolean indicating if the syllable is the initial syllable in the Word

syllablePosition()

syllablePosition(syllable): number

Defined in: word.ts:417

Gets the position of a syllable within the Word

Parameters

Parameter	Type	Description
`syllable`	`Syllable`	-

Returns

number

the position of the syllable within the Word (0-based index)