README.md

havarotjs

A Typescript package for getting syllabic data about Hebrew text with niqqud.

The general idea of this package is that a Text is composed of Words which are composed of Syllables which are composed of Clusters which are composed of Characters.

install

Using npm:

npm install havarotjs

To call using TypeScript:

import { Text } from "havarotjs";

Or Node (v15.0.0 is newer):

const havarot = require("havarotjs");
const Text = havarot.Text;
const heb = new Text("אֱלֹהִים");

example

import { Text } from "havarotjs";
const heb = "אֱלֹהִים";
const text = new Text(heb);
const sylText = text.syllables.map((syl) => syl.text);
sylText;
//  [
//    "אֱ"
//    "לֹ"
//    "הִים"
//  ]

Docs

Read the docs at online here

Contributing

Free to open an issue or pull request.

See the terms list for a list of naming conventions.

All Hebrew test input should be from Sefaria using the Miqra 'al pi ha-Mesorah text (unless another text is needed for a specific reason)