@jlceda/pro-api-types 0.1.60 → 0.1.62

package/README.en.md

@@ -0,0 +1,25 @@
+[简体中文](./README.md) | [English](#)
+
+# pro-api-types
+
+JLCEDA & EasyEDA Pro Edition Extension API Interface Type Definition
+
+<img src="https://easyeda-docs.coding.net/badges/eda-sdk/job/4639863/build.svg" alt="Build Status" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/v/%40jlceda%2Fpro-api-types" alt="NPM Version" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/unpacked-size/%40jlceda%2Fpro-api-types" alt="NPM Unpacked Size" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/l/%40jlceda%2Fpro-api-types" alt="NPM License" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/d18m/%40jlceda%2Fpro-api-types" alt="NPM Downloads" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />
+
+## How to Use
+
+It is recommended to use [pro-api-sdk](https://github.com/jlceda/pro-api-sdk) for extension development, this definition file is pre-configured within the SDK.
+
+1. 安装类型定义
+
+    ```shell
+    npm install --save-dev @jlceda/pro-api-types
+    ```
+
+2. Add `./node_modules/@jlceda/pro-api-types/` into `tsconfig.include`
+
+## Open Source License
+
+<a href="https://choosealicense.com/licenses/apache-2.0/" style="vertical-align: inherit;" target="_blank"><img src="https://img.shields.io/npm/l/%40jlceda%2Fpro-api-types" alt="NPM License" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" /></a>
+
+This typedef uses the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) open source license, and you may only use the **嘉立创EDA**, **EasyEDA** trademark information in the **Functional Description** and **Title of Open Source Release** sections of the extension packages developed by the [pro-api-sdk](https://github.com/jlceda/pro-api-sdk) toolset, and the **Title of Open Source Release** section. **Functional Description Section** and **Title Section** of the Open Source Release for extension packages developed by the toolset.

package/README.md

@@ -1,16 +1,14 @@
+[简体中文](#) | [English](./README.en.md)
+
 # pro-api-types
 
 嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义
 
-[![Build Status](https://easyeda-docs.coding.net/badges/eda-sdk/job/4639863/build.svg)](https://easyeda-docs.coding.net/p/eda-sdk/ci/job)
-![NPM Version](https://img.shields.io/npm/v/%40jlceda%2Fpro-api-types)
-![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40jlceda%2Fpro-api-types)
-![NPM License](https://img.shields.io/npm/l/%40jlceda%2Fpro-api-types)
-![NPM Downloads](https://img.shields.io/npm/d18m/%40jlceda%2Fpro-api-types)
+<img src="https://easyeda-docs.coding.net/badges/eda-sdk/job/4639863/build.svg" alt="Build Status" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/v/%40jlceda%2Fpro-api-types" alt="NPM Version" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/unpacked-size/%40jlceda%2Fpro-api-types" alt="NPM Unpacked Size" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/l/%40jlceda%2Fpro-api-types" alt="NPM License" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />&nbsp;<img src="https://img.shields.io/npm/d18m/%40jlceda%2Fpro-api-types" alt="NPM Downloads" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" />
 
 ## 使用
 
-建议使用 [pro-api-sdk](https://github.com/jlceda/pro-api-sdk) 进行扩展开发，本定义文件已在 SDK 内预配。
+建议使用 [pro-api-sdk](https://gitee.com/jlceda/pro-api-sdk) 进行扩展开发，本定义文件已在 SDK 内预配。
 
 1. 安装类型定义
 
@@ -22,4 +20,6 @@
 
 ## 开源许可
 
-本类型定义使用 [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) 开源许可协议，你仅可以将 **嘉立创EDA**、**EasyEDA** 商标信息用于依托于 [pro-api-sdk](https://github.com/jlceda/pro-api-sdk) 工具组开发的扩展包的 **功能描述部分** 和 **开源发布的标题部分**。
+<a href="https://choosealicense.com/licenses/apache-2.0/" style="vertical-align: inherit;" target="_blank"><img src="https://img.shields.io/npm/l/%40jlceda%2Fpro-api-types" alt="NPM License" class="not-medium-zoom-image" style="display: inline; vertical-align: inherit;" /></a>
+
+本类型定义使用 [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) 开源许可协议，你仅可以将 **嘉立创EDA**、**EasyEDA** 商标信息用于依托于 [pro-api-sdk](https://gitee.com/jlceda/pro-api-sdk) 工具组开发的扩展包的 **功能描述部分** 和 **开源发布的标题部分**。

package/index.d.ts

@@ -195,7 +195,7 @@ declare class DMT_Folder {
      * @param teamUuid - 团队 UUID
      * @param parentFolderUuid - 父文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 文件夹描述
-     * @returns 文件夹 UUID，如若为 `undefined` 则创建失败
+     * @returns 文件�� UUID，如若为 `undefined` 则创建失败
      */
     createFolder(folderName: string, teamUuid: string, parentFolderUuid?: string, description?: string): Promise<string | undefined>;
     /**
@@ -412,7 +412,7 @@ declare class DMT_Project {
      *
      * @beta
      * @param projectFriendlyName - 工程友好名称
-     * @param projectName - 工程名称，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好名称���动生成
+     * @param projectName - 工程名称，仅支持字母 `a-zA-Z`、数字 `0-9`、中划线 `-`，如若不指定，则根据工程友好名称自动生成
      * @param teamUuid - 团队 UUID，如若不指定，则默认为个人；在不存在个人工程的环境下必须指定团队 UUID
      * @param folderUuid - 文件夹 UUID，如若不指定，则为根文件夹
      * @param description - 工程描述
@@ -2860,7 +2860,7 @@ declare class IPCB_PrimitiveLine implements IPCB_Primitive {
      */
     toSync(): IPCB_PrimitiveLine;
     /**
-     * 查询图��是否为异步图元
+     * 查询图���是否为异步图元
      */
     isAsync(): boolean;
     /**
@@ -3401,7 +3401,7 @@ declare class ISCH_PrimitiveArc implements ISCH_Primitive {
      * 在原理图画布中创建图元
      *
      * @beta
-     * @returns 圆弧图元对象
+     * @returns 圆弧图元��象
      */
     create(): Promise<ISCH_PrimitiveArc>;
     getState_PrimitiveType(): string;
@@ -4223,7 +4223,7 @@ declare class LIB_3DModel {
      * @beta
      * @param modelUuid - 3D 模型 UUID
      * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
-     * @returns 操作是否成功
+     * @returns ���作是否成功
      */
     delete(modelUuid: string, libraryUuid: string): Promise<boolean>;
     /**
@@ -4784,7 +4784,7 @@ declare class LIB_PanelLibrary {
      *
      * @beta
      * @param key - 搜索关键字
-     * @param libraryUuid - 库 UUID，默认为系统库��可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param libraryUuid - 库 UUID，默认为系统库，可以使用 {@link LIB_LibrariesList} 内的接口获取
      * @param classification - 分类，默认为全部
      * @param itemsOfPage - 一页搜索结果的数量
      * @param page - 页数
@@ -5224,7 +5224,7 @@ declare class PCB_Drc {
      * 创建差分对
      *
      * @beta
-     * @param differentialPairName - 差分对名称
+     * @param differentialPairName - 差分对名��
      * @param positiveNet - 正网络名称
      * @param negativeNet - 负网络名称
      * @returns 操作是否成功
@@ -7307,7 +7307,7 @@ declare class SCH_PrimitivePolygon implements ISCH_PrimitiveAPI {
      * 获取多边形
      *
      * @beta
-     * @param primitiveIds - 多边形的图��� ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 多边形的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 多边形图元对象
      */
     get(primitiveIds: string): Promise<ISCH_PrimitivePolygon | undefined>;
@@ -7631,6 +7631,7 @@ declare class SYS_ClientUrl {
      * @param data - 请求发送的数据，可以是直接数据或 {@link https://developer.mozilla.org/docs/Web/API/URLSearchParams | URLSearchParams} 对象，如果 method 为 `HEAD` 或 `GET`，本参数将被忽略
      * @param options - 请求参数
      * @param succeedCallFn - 请求成功后回调的函数
+     * @returns Fetch 的返回结果
      */
     request(url: string, method?: 'GET' | 'POST' | 'HEAD' | 'PUT' | 'DELETE' | 'PATCH', data?: string | Blob | FormData | URLSearchParams, options?: {
         headers?: {
@@ -7670,7 +7671,7 @@ declare class SYS_FileManager {
      * 获取文档源码
      *
      * @beta
-     * @returns 文档源码数据，`undefined` 表示当前未打开文档或数据获取失败
+     * @returns 文档源码数据���`undefined` 表示当前未打开文档或数据获取失败
      */
     getDocumentSource(): Promise<string | undefined>;
     /**
@@ -8172,6 +8173,7 @@ declare class SYS_Timer {
      * @param timeout - 定时时间，单位 ms
      * @param callFn - 定时调用函数
      * @param argument - 传给定时调用函数的参数
+     * @returns 定时器是否设置成功
      */
     setIntervalTimer(id: string, timeout: number, callFn: (argument: any) => void, argument?: any): boolean;
     /**
@@ -8179,6 +8181,7 @@ declare class SYS_Timer {
      *
      * @public
      * @param id - 定时器 ID
+     * @returns 定时器是否清除成功
      */
     clearIntervalTimer(id: string): boolean;
     /**
@@ -8188,6 +8191,7 @@ declare class SYS_Timer {
      * @param timeout - 定时时间，单位 ms
      * @param callFn - 定时调用函数
      * @param argument - 传给定时调用函数的参数
+     * @returns 定时器是否设置成功
      */
     setTimeoutTimer(timeout: number, callFn: (argument: any) => void, argument?: any): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.60",
+	"version": "0.1.62",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [
@@ -30,7 +30,7 @@
 		"eslint-plugin-tsdoc": "^0.3.0",
 		"fast-text-encoding": "^1.0.6",
 		"fs-extra": "^11.2.0",
-		"husky": "^9.1.1",
+		"husky": "^9.1.3",
 		"lint-staged": "^15.2.7",
 		"prettier": "^3.3.3",
 		"ts-node": "^10.9.2",