@kmaslesa/holy-quran-word-by-word-min v1.0.4

بسم الله الرحمن الرحيم

Holy Quran - word by word

Installation

npm i @kmaslesa/holy-quran-word-by-word-min

Usage

const quranWords = require('@kmaslesa/holy-quran-word-by-word-min');

quranWords.getWordsByPage(1).then((data: QuranData) => {
  console.log(data);
});

quranWords.getAllQuranWords().then((data: QuranData[]) => {
  console.log(data);
});

INTERFACES

export interface QuranData {
  ayahs?: Ayah[] | null;
  page: number;
}
export interface Ayah {
  words?: (Word | null)[] | null;
  metaData: MetaData;
}
export interface Word {
  audio?: string | null;
  charType: string;
  codeV1: string;
  ayahKey: string;
  ayahIndex: number;
}

export interface MetaData {
  lineType?: string | null;
  suraName?: string | null;
}

quranWords.getWordsByPage(1).then((data: QuranData) => {
  console.log(JSON.stringify(data));
});

quranWords.getAllQuranWords().then((data: QuranData[]) => {
  console.log(JSON.stringify(data));
});

RESPONSE: [
  {
    page: 1,
    ayahs: [
      {
        metaData: {
          lineType: 'start_sura',
          suraName: 'الفاتحة - Al-Fatihah',
        },
        words: [],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭑ',
            audio: 'wbw/001_001_001.mp3',
            charType: 'word',
            ayahKey: '1:1',
            ayahIndex: 1,
          },
          {
            codeV1: 'ﭒ',
            audio: 'wbw/001_001_002.mp3',
            charType: 'word',
            ayahKey: '1:1',
            ayahIndex: 1,
          },
          {
            codeV1: 'ﭓ',
            audio: 'wbw/001_001_003.mp3',
            charType: 'word',
            ayahKey: '1:1',
            ayahIndex: 1,
          },
          {
            codeV1: 'ﭔ',
            audio: 'wbw/001_001_004.mp3',
            charType: 'word',
            ayahKey: '1:1',
            ayahIndex: 1,
          },
          {
            codeV1: 'ﭕ',
            audio: null,
            charType: 'end',
            ayahKey: '1:1',
            ayahIndex: 1,
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭖ',
            audio: 'wbw/001_002_001.mp3',
            charType: 'word',
            ayahKey: '1:2',
            ayahIndex: 2,
          },
          {
            codeV1: 'ﭗ',
            audio: 'wbw/001_002_002.mp3',
            charType: 'word',
            ayahKey: '1:2',
            ayahIndex: 2,
          },
          {
            codeV1: 'ﭘ',
            audio: 'wbw/001_002_003.mp3',
            charType: 'word',
            ayahKey: '1:2',
            ayahIndex: 2,
          },
          {
            codeV1: 'ﭙ',
            audio: 'wbw/001_002_004.mp3',
            charType: 'word',
            ayahKey: '1:2',
            ayahIndex: 2,
          },
          {
            codeV1: 'ﭚ',
            audio: null,
            charType: 'end',
            ayahKey: '1:2',
            ayahIndex: 2,
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭛ',
            audio: 'wbw/001_003_001.mp3',
            charType: 'word',
            ayahKey: '1:3',
          },
          {
            codeV1: 'ﭜ',
            audio: 'wbw/001_003_002.mp3',
            charType: 'word',
            ayahKey: '1:3',
          },
          {
            codeV1: 'ﭝ',
            audio: null,
            charType: 'end',
            ayahKey: '1:3',
          },
          {
            codeV1: 'ﭞ',
            audio: 'wbw/001_004_001.mp3',
            charType: 'word',
            ayahKey: '1:4',
          },
          {
            codeV1: 'ﭟ',
            audio: 'wbw/001_004_002.mp3',
            charType: 'word',
            ayahKey: '1:4',
          },
          {
            codeV1: 'ﭠ',
            audio: 'wbw/001_004_003.mp3',
            charType: 'word',
            ayahKey: '1:4',
          },
          {
            codeV1: 'ﭡ',
            audio: null,
            charType: 'end',
            ayahKey: '1:4',
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭢ',
            audio: 'wbw/001_005_001.mp3',
            charType: 'word',
            ayahKey: '1:5',
          },
          {
            codeV1: 'ﭣ',
            audio: 'wbw/001_005_002.mp3',
            charType: 'word',
            ayahKey: '1:5',
          },
          {
            codeV1: 'ﭤ',
            audio: 'wbw/001_005_003.mp3',
            charType: 'word',
            ayahKey: '1:5',
          },
          {
            codeV1: 'ﭥ',
            audio: 'wbw/001_005_004.mp3',
            charType: 'word',
            ayahKey: '1:5',
          },
          {
            codeV1: 'ﭦ',
            audio: null,
            charType: 'end',
            ayahKey: '1:5',
          },
          {
            codeV1: 'ﭧ',
            audio: 'wbw/001_006_001.mp3',
            charType: 'word',
            ayahKey: '1:6',
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭨ',
            audio: 'wbw/001_006_002.mp3',
            charType: 'word',
            ayahKey: '1:6',
          },
          {
            codeV1: 'ﭩ',
            audio: 'wbw/001_006_003.mp3',
            charType: 'word',
            ayahKey: '1:6',
          },
          {
            codeV1: 'ﭪ',
            audio: null,
            charType: 'end',
            ayahKey: '1:6',
          },
          {
            codeV1: 'ﭫ',
            audio: 'wbw/001_007_001.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭬ',
            audio: 'wbw/001_007_002.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭭ',
            audio: 'wbw/001_007_003.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭮ',
            audio: 'wbw/001_007_004.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭯ',
            audio: 'wbw/001_007_005.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭰ',
            audio: 'wbw/001_007_006.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭱ',
            audio: 'wbw/001_007_007.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
        ],
      },
      {
        metaData: {},
        words: [
          {
            codeV1: 'ﭲ',
            audio: 'wbw/001_007_008.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭳ',
            audio: 'wbw/001_007_009.mp3',
            charType: 'word',
            ayahKey: '1:7',
          },
          {
            codeV1: 'ﭴ',
            audio: null,
            charType: 'end',
            ayahKey: '1:7',
          },
        ],
      },
    ],
  },
];

License

MIT