Tanzil Downloader

Download Quran text from tanzil.net.

Installation

$ npm install tanzil-downloader

Usage

Download Quran text and save it to quran.txt.

const tanzilDownloader = require("tanzil-downloader");

(async () => {
  try {
    await tanzilDownloader("quran.txt");
  } catch(error) {
    console.error(error.message);
  }
})();

API

tanzilDownloader(destination, [options]);

Parameters

• destination (String): Location to save the downloaded file to.
• options (optional Object): tanzil.net Quran text download options
  • type (String): The Quran type to download, default to uthmani.
  • output (String): The output type, default to txt-2 (text with verse numbers).
  • pauseMarks (Boolean): Includes the pause marks, default to true.
  • sajdahSigns (Boolean): Includes the sajdah signs (۩), default to true.
  • rubElHizbSigns (Boolean): Includes the rub-el-hizb signs (۞), default to true.
  • superscriptAlif (Boolean): Includes the superscript alif, default to true. Only applicable to type: simple, simple-enhanced, and simple-min.
  • differentTanweenShapes (Boolean): Use different tanween shapes (only for me_quran font), default to false. Only applicable to type: uthmani

Quran Type

The following Quran types are available to download:

• simple: Quran text in Imlaaei script.
• simple-enhanced: Simple text without special demonstration of Ikhfas and Idghams.
• simple-min: Simple text with minimal number of diacritics and symbols.
• simple-clean: Simple text with no diacritics or symbols.
• uthmani: Uthmani text, according to Medina Mushaf.
• uthmani-min: Uthmani text with minimal number of diacritics and symbols.

Output Type

The following output types are available:

• txt: Text file format.
• txt-2: Text filr format with verse numbers.
• xml: XML file format.
• sql: MySQL dump file.

Related

• Quran JSON: Quran text and translations in JSON format.

License

MIT © Risan Bagja Pradana

Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Tanzil.net or any of its affiliates or subsidiaries. This is an independent and unofficial library.

By downloading the Quran text from Tanzil.net you agree to Tanzil's terms of use:

#  - This quran text is distributed under the terms of a
#    Creative Commons Attribution 3.0 License.
#
#  - Permission is granted to copy and distribute verbatim copies
#    of this text, but CHANGING IT IS NOT ALLOWED.
#
#  - This quran text can be used in any website or application,
#    provided its source (Tanzil.net) is clearly indicated, and
#    a link is made to http://tanzil.net to enable users to keep
#    track of changes.
#
#  - This copyright notice shall be included in all verbatim copies
#    of the text, and shall be reproduced appropriately in all files
#    derived from or containing substantial portion of this text.