# waris-calculator

> Calculate share inheritance in Islam

Latest version **2.0.0** (published 2023-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install waris-calculator
pnpm add waris-calculator
yarn add waris-calculator
bun add waris-calculator
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-07-13 |
| First published | 2023-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 41.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Panawar Hasibuan |
| Maintainers | panawar |

## Links

- npm: https://www.npmjs.com/package/waris-calculator
- Repository: https://github.com/nawarhasibuan/waris-calculator
- Homepage: https://github.com/nawarhasibuan/waris-calculator#readme
- Issues: https://github.com/nawarhasibuan/waris-calculator/issues
- npm.io page: https://npm.io/package/waris-calculator

## Dependencies (1)

- [fraction.js](https://npm.io/package/fraction.js.md) ^4.2.0

## Recent versions

- 2.0.0 (latest) — 2023-07-13
- 1.0.0 — 2023-06-27

## README

# CalcWaris

Modules to calculate inheritance based on islamic belief.

#### contents

- [Quickstart](#quickstart)
  - [Installing](#installing)
  - [Example](#example)
- [Issue](#issue)
- [Licence](#licence)
- [Reference](#reference)

## Quickstart

### Installing

Using npm:

```bash
$ npm install waris-calculator
```

using yarn:

```bash
$ 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](https://github.com/nawarhasibuan/waris-calculator/issues)

## LICENCE

MIT

## Reference

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

---
_Source: https://npm.io/package/waris-calculator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._