azkar/index.js

Package to get Islamic azkar and supplications easily

(function() {
  "use strict";
  /*
  * ST Studio 
  * https://discord.gg/st-studio
  * https://dsc.gg/shuruhatik
  */
  const azkars = require('./azkars.json')
  const categorys = require('./categorys.json')
  function randomValueFromArray(arr) {
    return arr[Math.floor(Math.random() * arr.length)]
  }

  /**
   * @name getCategory
   * @description Get a category from the categorys
   * @param {number | string} category 
   * @returns 
   */
  function getCategory(category) {
    if (!isNaN(parseFloat(category)) && isFinite(category)) return categorys[category]
    else return azkars[category] ? category : undefined;
  }

  /**
   * @name get
   * @description Getting a random male in a specific category
   * @returns {Map}
   */
  function get(input) {
    if (!input) return random()
    if (input.category) input = input.category;
    if (!getCategory(input)) throw Error("ﻑﺮﻌﻤﻟﺍ ﺍﺬﻫ ﻲﻠﻋ ﻝﻮﺼﺤﻟﺍ ﻊﻴﻄﺘﺴﺗ ﻢﻟ ← ﺭﺎﻛﺫﻷﺍ ﺔﻣﺰﺣ");
    return randomValueFromArray(azkars[getCategory(input)])
  }

  /**
   * @name all
   * @description get all azkars
   * @returns {Map}
   */
  function all() {
    return new Map(Object.entries(azkars))
  }

  /**
   * @name random
   * @description Get a random azkar
   * @returns {Object}
   */
  function random(zekr = false) {
    return !zekr ? randomValueFromArray(randomValueFromArray(Object.values(azkars))) : randomValueFromArray(Object.values(azkars))
  }

  module.exports = { all, get, random, categorys, azkars, getCategory }
}).call(this);