SylOpts
options for determining syllabification that may differ according to reading traditions
Properties
allowNoNiqqud?
optional
allowNoNiqqud:boolean
allows text with no niqqud to be passed; words with no niqqud or incomplete pointing will not be syllabified
Default Value
Example
Remarks
results in example displayed in reverse order to mimic Hebrew writing; the rightmost value is the 0 item
Defined in
node_modules/havarotjs/dist/types/text.d.ts:24
article?
optional
article:boolean
determines whether to regard the sheva under the letters ילמ when preceded by the article and with a missing dagesh chazaq as as a sheva na’.
Default Value
Example
Remarks
results in example displayed in reverse order to mimic Hebrew writing; the rightmost value is the 0 item
Defined in
node_modules/havarotjs/dist/types/text.d.ts:44
holemHaser?
optional
holemHaser:"update"
|"preserve"
|"remove"
how to handle the code point \u{05BA} HOLAM HASER FOR VAV
Options
- ”update” - converts all holems in a vav + holem sequence where vav is a consonant to HOLAM HASER FOR VAV
- ”preserve” - leaves the text as is — does not remove HOLAM HASER FOR VAV, but does not update
- ”remove” - converts all HOLAM HASER FOR VAV to regular holem
Default Value
Examples
Defined in
node_modules/havarotjs/dist/types/text.d.ts:84
longVowels?
optional
longVowels:boolean
determines whether to regard a sheva after a long vowel (excluding waw-shureq, see wawShureq) as a sheva na’, unless preceded by a meteg (see shevaAfterMeteg).
Default Value
Example
Remarks
results in example displayed in reverse order to mimic Hebrew writing; the rightmost value is the 0 item
Defined in
node_modules/havarotjs/dist/types/text.d.ts:104
qametsQatan?
optional
qametsQatan:boolean
converts regular qamets characters to qamets qatan characters where appropriate. The former is a “long-vowel” whereas the latter is a “short-vowel.”
Default Value
Example
Defined in
node_modules/havarotjs/dist/types/text.d.ts:121
shevaAfterMeteg?
optional
shevaAfterMeteg:boolean
determines whether to regard the sheva after a meteg as a sheva na’.
Default Value
Example
Defined in
node_modules/havarotjs/dist/types/text.d.ts:146
shevaWithMeteg?
optional
shevaWithMeteg:boolean
determines whether to regard a sheva with a meteg as a sheva na’. This is also called a sheva ga’ya.
Default Value
Example
Defined in
node_modules/havarotjs/dist/types/text.d.ts:169
sqnmlvy?
optional
sqnmlvy:boolean
determines whether to regard the sheva under the letters שׁשׂסצנמלוי when preceded by a waw-consecutive with a missing dagesh chazaq as a sheva na’, unless preceded by a meteg (see shevaAfterMeteg).
Default Value
Example
Defined in
node_modules/havarotjs/dist/types/text.d.ts:185
strict?
optional
strict:boolean
whether to syllabify incorrectly pointed text
Default Value
Example
Remarks
when false results in syllabification can vary
Defined in
node_modules/havarotjs/dist/types/text.d.ts:205
wawShureq?
optional
wawShureq:boolean
determines whether to regard a sheva after a vav-shureq as vocal, unless preceded by a meteg (see shevaAfterMeteg).
Default Value
Example
Remarks
results in example displayed in reverse order to mimic Hebrew writing; the rightmost value is the 0 item
Defined in
node_modules/havarotjs/dist/types/text.d.ts:225