Nebulous Pumpkin Moons

    havarotjs
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.2 • Public • Published

    havarot

    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:

    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.

    Install

    npm i havarotjs

    DownloadsWeekly Downloads

    138

    Version

    0.9.2

    License

    MIT

    Unpacked Size

    112 kB

    Total Files

    45

    Last publish

    Collaborators

    • charlesloder