tajweed-ts
v1.0.0
Published
Tajweed and buck parsing library.
Downloads
7
Maintainers
Readme
Tajweed
Tajweed-ts is npm package for Tajweed and Buck
Quran Tools for Parsing Tajweed and Buck
The npm package is to be used with the AlQuran.cloud and GlobalQuran.com APIs. They are made available so you may get the most out of the APIs.
Installation
Use the package manager npm to install Tajweed.
npm install tajweed-ts
#or
yarn add tajweed-ts
#or
pnpm add tajweed-ts
Usage
const { Tajweed } = require("tajweed-ts");
let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; //
let parseTajweed = new Tajweed();
let parseString = parseTajweed.parse("string", true);
console.log(parseString);
OR
import "tajweed-ts/tajweed.css";
import { Tajweed } from "tajweed-ts";
function App() {
let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; //
let parseTajweed = new Tajweed();
let parseString = parseTajweed.parse(string, true);
return <div dangerouslySetInnerHTML={{ __html: parseString }}></div>;
}
export default App;
OR
import { Tajweed } from "tajweed-ts";
let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; //
let parseTajweed = new Tajweed();
let parseString = parseTajweed.parse(string, true);
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Source code is taken from https://github.com/aamirbhat382/Tajweed @aamirbhat382, moved to typescript and added few tests.