npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wind-tsdoc

v1.0.10

Published

## 该工具共有三个功能,init/add/config

Downloads

13

Readme

通过puppeteer、ts-morph和commander编写命令行工具,抓取api文档的接口数据,利用事件监听响应机制,动态生成ts文档以及支持智能添加

该工具共有三个功能,init/add/config

  1. 先通过tsdoc config xxx.js命令初始化配置信息(其中xxx.js为实际的配置文件地址),进行初始化。

  2. 在对应的文件夹下执行tsdoc init xxx命令,初始化请求api对应的index.ts文件和对应类型以及注释的type.ts文件(其中xxx为实际的api接口地址)。如果想覆盖已经生成的index.ts文件和type.ts文件,可以通过添加-f参数,强制覆盖:tsdoc init -f xxx

  3. 在已经生成文件的目录下,可以通过执行tsdoc add xxx命令,在源文件上动态添加新的api文档描述

需要先手动执行tsdoc config命令进行初始化,不然无法执行后续的命令

config文件的格式如下

// config.js文件
module.exports = {
	username: "", // 实际的用户名
	password: "", // 实际的用户密码
	fetchfilePath: "@/utils/fetch/index", // 实际的请求文件地址
	responsefilePath: "@/utils/fetch/type", // 实际的请求类型文件地址
};