Char

Defined in: char.ts:10

A Hebrew character and its positioning number for being sequenced correctly. See Cluster for correct normalization.

Extends

Node<Char, null, Cluster>

Constructors

Constructor

new Char(char): Char

Defined in: char.ts:15

Parameters

Parameter	Type
`char`	`string`

Returns

Char

Overrides

Node.constructor

Properties

children

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

Defined in: node.ts:21

Collection of child nodes.

Inherited from

Node.children

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

Defined in: node.ts:11

Next sibling in the sequence.

Inherited from

Node.next

parent

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

Defined in: node.ts:18

Reference to the parent container.

Inherited from

Node.parent

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

Defined in: node.ts:13

Previous sibling in the sequence.

Inherited from

Node.prev

value

value: Char | null = null

Defined in: node.ts:15

Node data.

Inherited from

Node.value

Accessors

cluster

Get Signature

get cluster(): Cluster | null

Defined in: char.ts:96

The parent Cluster of the character

Example

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

Returns

Cluster | null

isConsonant

Get Signature

get isConsonant(): boolean

Defined in: char.ts:125

Returns true if the character is a consonant

Example

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

Returns

boolean

isDagesh

Get Signature

get isDagesh(): boolean

Defined in: char.ts:153

Returns true if the character is a dagesh

Example

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

Returns

boolean

isLigature

Get Signature

get isLigature(): boolean

Defined in: char.ts:139

Returns true if the character is a ligature

Example

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

Returns

boolean

isNotHebrew

Get Signature

get isNotHebrew(): boolean

Defined in: char.ts:223

Returns true if the character is not a Hebrew character

Example

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

Returns

boolean

isRafe

Get Signature

get isRafe(): boolean

Defined in: char.ts:167

Returns true if the character is a rafe

Example

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

Returns

boolean

isSheva

Get Signature

get isSheva(): boolean

Defined in: char.ts:181

Returns true if the character is a sheva

Example

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

Returns

boolean

isTaamim

Get Signature

get isTaamim(): boolean

Defined in: char.ts:209

Returns true if the character is a taamim

Example

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

Returns

boolean

isVowel

Get Signature

get isVowel(): boolean

Defined in: char.ts:195

Returns true if the character is a sheva

Example

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

Returns

boolean

name

Get Signature

get 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" | "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" | null

Defined in: char.ts:237

Returns the name of the character

Example

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

Returns

sequencePosition

Get Signature

get sequencePosition(): number

Defined in: char.ts:264

Gets the sequence position of the character

Example

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

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

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

text

Get Signature

get text(): string

Defined in: char.ts:280

The text of the character

Example

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

Returns

string

the text of the Char

Methods

isCharacterName()

isCharacterName(name): boolean

Defined in: char.ts:105

Returns true if the character is a character name

Parameters

Parameter	Type	Description
`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"` \| `"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"`	a character name

Returns

boolean