# myquran

> A simple API wrapper for api.myquran.com

Latest version **1.0.1** (published 2023-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install myquran
pnpm add myquran
yarn add myquran
bun add myquran
```

## 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 | 1.0.1 |
| Published | 2023-06-05 |
| First published | 2023-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 (+12 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ray |
| Maintainers | ray_1337 |
| Keywords | api, myquran, indonesia, kemenag, quran |

## Links

- npm: https://www.npmjs.com/package/myquran
- Repository: https://github.com/ray-1337/myquran
- Homepage: https://github.com/ray-1337/myquran#readme
- Issues: https://github.com/ray-1337/myquran/issues
- npm.io page: https://npm.io/package/myquran

## Dependencies (1)

- [undici](https://npm.io/package/undici.md) ^5.22.1

## Recent versions

- 1.0.1 (latest) — 2023-06-05
- 1.0.0 — 2023-06-05

## README

# api.myquran.com
This is an unofficial lightweight (~5kB) API wrapper of `api.myquran.com`, with TypeScript typings.

# Examples
```js
// JavaScript
const { findPrayCityByKeyword } = require("myquran");
const city = await findPrayCityByKeyword("depok");
console.log(city.data.lokasi); // "KOTA DEPOK"
```

```ts
// TypeScript
import { getTafsirByID } from "myquran";
const tafsir = await getTafsirByID("1337");
console.log(tafsir.data[0].text); // "Dan ada pula orang lain yang berada di sekeliling ..."
```

# Features
- TypeScript supports.
- Async-await promise.
- Simple error handling. Simply will return as `null` instead of `{ status: false, message: string }`

# Documentations
Everything is picked up based on [api-myquran.com](https://bit.ly/api-v1-myquran) docs.

# LICENSE
[MIT](LICENSE)

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