@ghoran/text
Version:
44 lines • 1.79 kB
TypeScript
//#region src/types.d.ts
/**
* نوع متن قرآن
*
* tanzil-simple-clean: متن بدون علامت، مناسب برای جستجو
* tanzil-simple-min: متن کم علامت، برای کپی و اشتراک گذاری در برنامه‌های مختلف
* imla: رسم الاملا
* hafs: رسم الخط عثمان طه اصلی - باید با فونت مربوطه استفاده شود
* hafs-v13: رسم الخط عثمان طه اصلی نسخه قدیمی - باید با فونت مربوطه استفاده شود
* hafs-v3: رسم الخط عثمان طه نسخه ۳٫۰ - باید با فونت نسخه ۳ استفاده شود
*/
export type QuranTextType = 'tanzil-simple-clean' | 'tanzil-simple-min' | 'imla' | 'hafs' | 'hafs-v13' | 'hafs-v3' | 'qpc-v1' | 'qpc-v2';
/**
* مشخصات رسم الخط
*/
export type QuranTextMeta = {
name: QuranTextType;
};
//#endregion
//#region src/metadata.d.ts
/**
* لیست مشخصات رسم الخط‌های مختلف
*/
export declare const textMetaData: QuranTextMeta[];
//#endregion
//#region src/load-text.d.ts
/**
* مستقیما جیسون مربوط به متن قرآن را ایمپورت می‌کند
* @param type - نوع متن قرآن
* @returns خروجی مستقیم ایمپورت پویا
*/
export declare function importText(type: QuranTextType): Promise<{
default: string[];
}>;
/**
* بر اساس نوع ورودی متن قرآن متناظر را بارگیری می‌کند
* و نتیجه‌ی آن را کش می‌کند
* @param type - نوع متن قرآن
*/
export declare function loadText(type: QuranTextType, { cacheName, cachePrefix }?: {
cacheName?: string | undefined;
cachePrefix?: string | undefined;
}): Promise<string[]>;
//#endregion