首页
前端开发
Typescript
@jsdocs-io/extractor npm包API提取器

@jsdocs-io/extractor npm包API提取器

0 次浏览 0 条评论
zip
zip

npm 包 API 的提取器，平时要开源包的公共接口时，用它还挺顺手的。

@jsdocs-io/extractor的功能就一个：下载 npm 包，把它的公共 API 一股脑儿提出来。适合那种你想搞清楚某个包到底暴露了哪些接口，不想翻源码、文档又不全的情况。

用法也简单，比如你要query-registry这个包：

import { analyzeRegistryPackage } from '@jsdocs-io/extractor';


(async () => {
  const info = await analyzeRegistryPackage({ name: 'query-registry' });
})();

注意哦，过程是阻塞的，也就是说会卡一下，别在 UI 线程干这事儿就好。

安装就那一套，npm i @jsdocs-io/extractor 或 yarn add @jsdocs-io/extractor，挺轻量的。

如果你经常写库、做文档生成、或者搞 AST，这工具还蛮合适的。要看源码也方便，直接去 GitHub 翻。对了，它提出来的 API 格式跟 jsdocs.io 上看到的那一套一样，用来做二次也挺方便。

zip 文件大小：1.29MB