findByChapter
Get all ayahs for a specific chapter.
Params:
verses.findByChapter(id: ChapterId, options?: GetVerseOptions)
| Param | Type |
|---|---|
| id | ChapterId (minimum 1, maximum 114) |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByChapter('1');
quran.v4.verses.findByChapter('114');findByJuz
Get all ayahs for a Juz.
Params:
verses.findByJuz(juz: JuzNumber, options?: GetVerseOptions)
| Param | Type |
|---|---|
| juz | JuzNumber (minimum 1, maximum 30) |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByJuz('1');
quran.v4.verses.findByJuz('30');findByKey
Get a specific ayah with key. Key is combination of surah number and ayah number.
Params:
verses.findByKey(key: VerseKey, options?: GetVerseOptions)
| Param | Type | Description |
|---|---|---|
| key | VerseKey | surah number and ayah number separated by a colon. |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByKey('1:1');
quran.v4.verses.findByKey('101:5');findByPage
Get all ayahs for a specific page in the Quran.
Params:
verses.findByKey(page: PageNumber, options?: GetVerseOptions)
| Param | Type |
|---|---|
| page | PageNumber (minimum 1, maximum 604) |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByPage('1');
quran.v4.verses.findByPage('101');findRandom
Get a random ayah.
Params:
verses.findRandom(options?: GetVerseOptions)
| Param | Type |
|---|---|
| options | GetVerseOptions |
Example:
quran.v4.verses.findRandom();findByHizb
Get all ayahs of a specific Hizb.
Params:
verses.findByHizb(id: HizbNumber, options?: GetVerseOptions)
| Param | Type |
|---|---|
| hizb | HizbNumber (minimum 1, maximum 60) |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByHizb('1');
quran.v4.verses.findByHizb('60');findByRub
Get all ayahs of a specific Rub.
Params:
verses.findByRub(id: RubNumber, options?: GetVerseOptions)
| Param | Type |
|---|---|
| rub | RubNumber (minimum 1, maximum 240) |
| options | GetVerseOptions |
Example:
quran.v4.verses.findByRub('1');
quran.v4.verses.findByRub('240');