什么是 Angular 项目中的 tsconfig.api-extractor.json 文件

数字中国
• 阅读 435

在 Angular 项目中,"tsconfig.api-extractor.json" 是一个用于配置 API Extractor 工具的配置文件。API Extractor 是一个用于生成和管理 TypeScript 库的 API 文档的工具。它能够从 TypeScript 代码中提取公共 API 并生成清晰的文档,以便开发者能够更好地了解库的使用方式、函数、类、接口等。

"tsconfig.api-extractor.json" 文件是用于指导 API Extractor 的工作流程和行为的配置文件。它定义了用于生成 API 文档的源代码位置、输出目录、文件筛选规则、包含和排除的文件列表,以及其他相关的选项。

该配置文件通常位于项目的根目录下,并且以"tsconfig.api-extractor.json"的名称保存。在 Angular 项目中,它通常是与其他 TypeScript 配置文件(例如 "tsconfig.json")并存的。

下面是一个示例的 "tsconfig.api-extractor.json" 配置文件内容:

{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  "mainEntryPointFilePath": "<path_to_entry_point_file>",
  "dtsRollup": {
    "enabled": true,
    "publicTrimmedFilePath": "<path_to_public_trimmed_file>",
    "betaTrimmedFilePath": "<path_to_beta_trimmed_file>",
    "alphaTrimmedFilePath": "<path_to_alpha_trimmed_file>"
  },
  "apiReport": {
    "enabled": true,
    "reportFileName": "<api_report_filename>"
  },
  "docModel": {
    "enabled": true
  },
  "docModelJson": {
    "enabled": true,
    "outputFolder": "<output_folder_path>"
  },
  "compiler": {
    "configType": "tsconfig",
    "rootFolder": ".",
    "overrideTsconfig": {
      "extends": "./tsconfig.json",
      "compilerOptions": {
        "outDir": "./dist"
      }
    }
  }
}

在上述配置文件中,可以看到以下重要的配置选项:

  • "mainEntryPointFilePath":指定库的入口文件路径,API Extractor 将从该文件开始提取 API。
  • "dtsRollup":配置生成的 API 文件的路径和选项。
  • "apiReport":配置是否生成 API 报告以及报告文件的名称。
  • "docModel" 和 "docModelJson":配置是否启用生成 API 文档模型和相应的输出文件夹路径。
  • "compiler":与 TypeScript 编译器相关的配置,指定了编译器选项和路径。

通过配置 "tsconfig.api-extractor.json" 文件,开发者可以根据项目需求自定义 API Extractor 工具的行为,并生成清晰的 API 文档以供开发者使用和参考。

需要注意的是,"tsconfig.api-extractor.json" 是 Angular 项目中特定于 API Extractor 的配置文件,用于生成 API 文档。与此同时,还存在其他 TypeScript 配置文件(例如 "tsconfig.json")用于控制 TypeScript 编译器的行为。

点赞
收藏
评论区
推荐文章
blmius blmius
4年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
美凌格栋栋酱 美凌格栋栋酱
7个月前
Oracle 分组与拼接字符串同时使用
SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Jacquelyn38 Jacquelyn38
4年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
FLV文件格式
1.        FLV文件对齐方式FLV文件以大端对齐方式存放多字节整型。如存放数字无符号16位的数字300(0x012C),那么在FLV文件中存放的顺序是:|0x01|0x2C|。如果是无符号32位数字300(0x0000012C),那么在FLV文件中的存放顺序是:|0x00|0x00|0x00|0x01|0x2C。2.  
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
PHP创建多级树型结构
<!lang:php<?php$areaarray(array('id'1,'pid'0,'name''中国'),array('id'5,'pid'0,'name''美国'),array('id'2,'pid'1,'name''吉林'),array('id'4,'pid'2,'n
Wesley13 Wesley13
3年前
Java日期时间API系列36
  十二时辰,古代劳动人民把一昼夜划分成十二个时段,每一个时段叫一个时辰。二十四小时和十二时辰对照表:时辰时间24时制子时深夜11:00凌晨01:0023:0001:00丑时上午01:00上午03:0001:0003:00寅时上午03:00上午0
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Python进阶者 Python进阶者
1年前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这
数字中国
数字中国
Lv1
我自饮酒醉世间,贪得红尘一场欢。
文章
3
粉丝
0
获赞
0