waris-calculator v2.0.0

CalcWaris

Modules to calculate inheritance based on islamic belief.

contents

• Quickstart
  • Installing
  • Example
• Issue
• Licence
• Reference

Quickstart

Installing

Using npm:

$ npm install waris-calculator

using yarn:

$ yarn add waris-calculator

Example

import calculator, {Calculator, deceased, heir} from "calculator-waris";
import {HeirParams} from "calculator-waris/heir";

const calc = calculator()
//const calcFemale = calculator(deceased({gender: false}))

calc.push(heir({gender: false, relation: 'none', isPartner: true}))
calc.push(heir({gender: false, relation: 'child', isPartner: false}))
calc.push(heir({gender: true, relation: 'child', isPartner: false}))
calc.push(heir({gender: true, relation: 'sibling', isPartner: false}))

const result = calc.calculation
//result: Array<Fraction>, siham (shares) of heirs sequencially in push order

Issue

Bug report and reach us here

LICENCE

MIT

Reference

We use Ali, M. (2019). Bagi Waris nggak harus Tragis. Jakarta, Turos Khazanah Pustaka Islam, Indonesian translation for Ali, M. (2002). Al-Mawaris fi Syari'ah al Islamiyyah fi Dhau' al-Kitab wa as-Sunah. Kairo, Dar at-Taufiqiyah as reference. We prioritize majority opinion and mazhab syafii first.