README.md
1# Public Repository for API Declaration Files
2
3## Overview
4
5This repository is used to store .d.ts declaration files of JavaScript/TypeScript APIs and API-related tools.
6
7## Directory Structure
8
9```
10├─api
11| ├─@internal
12│ | ├─component
13│ | | └─ets # Declaration file for components in the TypeScript-based declarative development paradigm
14| | └─ets
15| ├─config # JavaScript-based web-like development paradigm
16| ├─form # JavaScript service widget
17| ├─@ohos.×××.d.ts # API declaration file
18| └─@system.×××.d.ts # Deprecated APIs
19├─build-tools
20 ├─api_check_plugin # Tool for checking API specifications
21 | ├─plugin
22 | ├─src
23 | └─test
24 └─collect_application_api # Tool for parsing used APIs
25 └─src
26```
27
28## Repositories Involved
29
30[interface-sdk_js](https://gitee.com/openharmony/interface_sdk-js/tree/master)
31
README_zh.md
1# API声明文件公共仓
2
3## 简介
4
5JS/TS API 公共仓，用来提交 API d.ts 声明文件以及API相关工具。
6
7## 目录
8
9```|
10├─api
11| ├─@internal
12│ | ├─component
13│ | | └─ets #基于TS扩展的声明式开发范式组件声明文件
14| | └─ets
15| ├─config #基于JS扩展的类Web范式
16| ├─form #JS服务卡片
17| ├─@ohos.×××.d.ts #API声明文件
18| └─@system.×××.d.ts #标记为停止维护的接口
19├─build-tools
20 ├─api_check_plugin #检查API规范的工具
21 | ├─config
22 | ├─plugin
23 | ├─src
24 | └─test
25 └─cllect_application_api #解析应用到的API的工具（旧）
26 | ├─deps
27 | └─src
28 └─api_collector #解析应用到的API的工具的工具（新）
29 | ├─scripts
30 | ├─src
31 | └─test
32 └─api_diff #比较两个版本sdk差异的工具（旧）
33 | ├─src
34 | └─version_diff_collection
35 └─collect_api #解析d.ts文件接口的基本信息的工具
36 | └─collect_base_api.js
37 └─diff_api #比较两个版本sdk差异工具（新）
38 | └─src
39 └─dts_parser #解析d.ts文件的工具
40 | ├─src
41 | └─test
42 └─jsdoc_format_plugin #检查并修复jsdoc规范错误的工具
43 | ├─loader
44 | ├─src
45 | └─test
46 └─permissions_converter #从config文件提取权限信息，为DevEco Studio提供权限的联想和校验
47 | └─convert.js
48 └─sdk_upgrade_assistance_plugin #SDK升级辅助工具，帮助开发者快速解决SDK升级导致的API不兼容问题
49 | └─src
50```
51
52## 相关仓
53
54[interface-sdk_js](https://gitee.com/openharmony/interface_sdk-js/tree/master)
55
56