TypeScript接口文档生成工具

Latest Version

Version

0.0.7

Update

June 16, 2021

Size

423KiB

Developer

Type Api Extension

Type Api是一个TypeScript接口文档生成器, 可以生成有类型声明的文档到你的剪贴板。

#### Pagination类使用泛型
为了减少无用的声明, 分页的接口不再声明`Pagination`类, 因此项目需要声明一个全局`Pagination`类, 接受泛型参数.
在项目的全局声明文件, 如`global.d.ts`加上如下声明:
```ts
// type-declarations/global.d.ts
type Pagination = {
pageList: T[]; // 实体对象列表
pageSize: number; // 每页返回多少条数据
pageNo: number; // 当前页码，从1开始
totalCount: number; // 总记录数
totalPage: number; // 总页数
nextPage: number; // 下一页页码
prePage: number; // 上一页页码
lastPage: boolean; // 是否最后一页
firstPage: boolean; // 是否第一页
};
```

##### PageInfo分页类
财务后端分页使用的是PageInfo类, 同样的在全局声明文件加上:
```ts
// type-declarations/global.d.ts
type PageInfo = {
pageNum: number;
pageSize: number;
size: number;
startRow: number;
endRow: number;
pages: number;
prePage: number;
nextPage: number;
isFirstPage: boolean;
isLastPage: boolean;
hasPreviousPage: boolean;
hasNextPage: boolean;
navigatePages: number;
navigatepageNums: number;
navigateFirstPage: number;
navigateLastPage: number;
total: number;
list: T[];
}
```

更多：https://git.lianjia.com/sh-fe/ts-declare-generator/-/blob/master/README.md

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "name": "Type Api", "version": "0.0.7", "description": "TypeScript\u63a5\u53e3\u6587\u6863\u751f\u6210\u5de5\u5177", "browser_action": { "default_title": "Type Api", "default_icon": "images/logo_01.png" }, "icons": { "48": "images/logo_01.png" }, "content_scripts": [ { "js": ["jquery-3.4.1.min.js", "toastr.min.js", "main.js"], "css": ["main.css", "toastr.min.css"], "matches": ["http://doc.shoff.ke.com/*/*"], "run_at": "document_start" } ], "background": { "scripts": ["background.js"], "persistent": false }, "options_page": "options.html", "permissions": ["storage"], "manifest_version": 2, "content_security_policy": "script-src 'self' https://ajax.googleapis.com; object-src 'self'"}

Download CRX(423KiB)