islamic-inheritance-calculator

NB: This a work in progress. if you spot an error in calculations, then please file an issue

install

$ npm i @hu-bcs1/islamic-inheritance-calculator

usage

import { defaultHeirs, calculate } from 'islamic-inheritance-calculator'

function printResults(results) {
  const fractionToString = r => ({ ...r, share: r.share.toFraction() })
  console.log(results.map(fractionToString))
}

const result = calculate({ wife: 3, son: 1, daughter: 1 })
printResuls(result)
//=> [
//     { name: 'wife',     count: 3, type: 'fard',  share: '1/8'  },
//     { name: 'son',      count: 1, type: 'tasib', share: '7/12' },
//     { name: 'daughter', count: 1, type: 'tasib', share: '7/24' }
//   ]

TODO

• ميراث الجد مع الإخوة
• ميراث الأخ الشقيق مع الإخوة لأم
• مسألة الرد
• مسألة العول
• add calculation steps explainer. see http://inheritance.ilmsummit.org/projects/inheritance/Results.aspx?TestCaseID=80
• add option to configure special cases
• add more test cases from http://inheritance.ilmsummit.org/projects/inheritance/testcasespage.aspx