123
API Extractor

API Extractor

API Extractor به شما کمک می کند تا کتابخانه های TypeScript را بهتر بنویسید: این امضاهای نوع صادر شده شما را تجزیه و تحلیل می کند و (1) یک وب سایت اسناد API تولید می کند ، (2) یک پرونده "rollup" .d.ts ایجاد می کند ، و (3) یک گزارش API برای تسهیل روابط عمومی ایجاد می کند.بررسی
API Extractor به توسعه دهندگان TypeScript کمک می کند تا سطح API را برای کتابخانه خود مدیریت کنند.به صورت بسته NPM "@ microsoft / api-استخراج" توزیع می شود.این سه نوع خروجی مختلف را تولید می کند: - گزارش API - استخراج API می تواند تمام صادرات از محل ورودی اصلی پروژه شما را ردیابی کرده و گزارشی تولید کند تا به عنوان مبنای گردش کار بررسی API مورد استفاده قرار گیرد.- .d.ts Rollaps - شبیه به این که چگونه Webpack می تواند تمام پرونده های JavaScript را در یک بسته نرم افزاری برای توزیع قرار دهد "،" API Extractor "می تواند اظهارات TypeScript شما را در یک پرونده .d.ts منفرد کند.این پرونده را می توان به منظور حذف اعلامیه های مشخص شده با استفاده از برچسب های TSDoc مانندbeta "یاinternal. - مستندات API - این ابزار برای هر یك از پروژه های خود یك پرونده JSON" Doc Document "ایجاد می كند .این پرونده JSON حاوی امضاهای نوع استخراج شده ونظرات توضیحات: ابزار همراه "api-documenter" می تواند از این پرونده ها برای تولید یک وب سایت مرجع API استفاده کند ، یا می توانید از آنها به عنوان ورودی برای خط لوله مستند سازی سفارشی استفاده کنید.

سایت اینترنتی:

امکانات

دسته بندی ها

گزینه های API Extractor برای Self-Hosted با مجوز منبع باز