مدخل إلى ملفات التصريحات في TypeScript

من موسوعة حسوب
اذهب إلى: تصفح، ابحث

مقدمة

هذا الدليل مصمَّم لإرشادك إلى كيفيّة كتابة ملفّات تصريحاتٍ (Declaration Files) عاليّة الجودة في TypeScript.

يفترض هذا الدليل أنّ لك معرفةً بأساسيّات لغة TypeScript. اقرأ توثيق لغة TypeScript لتفهم مبادئ اللغة الأساسيّة، خاصّة الأنواع ومجالات الأسماء.

الأقسام

ينقسم هذا الدليل إلى الأقسام التالية:

هياكل المكتبات

يُساعد دليل هياكل المكتبات على فهم أشكال المكتبات الشائعة وكيفيّة كتابة ملفّ تصريحٍ سليمٍ لكلّ شكل. إذا كنت تُحرّر ملفّ تصريحات موجودٍ أصلًا (كُتِب من طرف مبرمج آخر مثلًا)، فالغالب أنّك لا تحتاج إلى قراءة هذا القسم. ينبغي على كُتّاب ملفّات التصريحات الجديدة قراءةُ هذا القسم لفهم كيف يؤثّر شكل المكتبة على كتابة ملفّ تصريحات لها.

ملفات التصريحات اعتمادًا على الأمثلة

نحتاج أحيانًا إلى كتابة ملف تصريحاتٍ لمكتبةٍ ما انطلاقًا من أمثلة استخدام المكتبة (من توثيق المكتبة مثلا). يوضّح قسم كتابة ملفات التصريحات اعتمادًا على الأمثلة عددًا من أنماط الواجهات البرمجية (API patterns) الشائعة وكيفية إنشاء ملفات تصريحات لكل منها. هذا الدليل موجّه للمبتدئين في لغة TypeScript ممّن لا يفهمون جميع المبادئ الموجودة في TypeScript.

افعل ولا تفعل

يمكن بسهولةٍ تجنّب العديد من الأخطاء الشائعة عند كتابة ملفات التعريفات. يوضّح قسم افعل ولا تفعل الأخطاء الشائعة ويصف كيفيّة اكتشافها وكيفيّة إصلاحها. ينبغي على الكل قراءة هذا القسم لتجنّب الأخطاء الشائعة.

التعمق في ملفات التصريحات

قسم التعمق في ملفات التصريحات موجَّهٌ للكتّاب الخبراء ممّن يريدون فهم آلية عمل ملفات التصريحات، إذ يشرح القسم عددًا من المبادئ المتقدمة في كتابة التصريحات، ويوضّح كيفيّة استغلال هذه المبادئ لإنشاء ملفّات تصريحات أوضح وأبسط.

قوالب

ستجد في قسم قوالب عددًا من ملفّات التصريحات التي ستكون بمثابة نقطة بداية عند كتابة ملفّ جديد. انظر توثيق هياكل المكتبات لفهم القالب الذي عليك استعماله في حالتك.

النشر على منصة npm

يشرح قسم نشر ملفات التصريحات كيفيّة نشر ملفّاتك على npm ويوضّح كيفيّة إدارة الحزم التي تعتمد عليها.

البحث عن ملفّات التصريحات وتثبيتها

يشرح قسم استخدام ملفات التصريحات لمستخدمي مكتبات JavaScript الخطوات البسيطة التي عليك اتباعها للبحث عن ملفّات التصريحات الخاصة بالمكتبة وكيفيّة تثبيتها.

مصادر