jsDoc npm 模块任务

jsdoc npm 模块任务

目前我正在工作/维护遗留的 js/react 应用程序,没有办法重新工作到 typesript,这就是为什么我打开 jsdoc 作为 js 现有的开发时类型系统。

太长了;

typescript npm 模块由 jsdoc 制作,useduck 在 70loc 下带回了 redux 的黄金时代。该模块在开发时的主要用例,帮助您的复杂状态保持类型安全。

const [state, quack] = useduck(reducer, initialstate, actionsmap);

jsdoc-duck

typescript jsdoc 之路

当我创建了一个轻量级的 react state npm 库时,我对 typescript 的体验更加深入了:react-state-factory

user declared 
state and actions types 
  -> usestatefactory 
  -> [state, dispatchedactoioncollection]

测试 jsdoc 限制

在我开始使用一些 jsdoc 注释来帮助我的工作之后,下一步有点更加大胆:将此模块重新设计为 jsdoc。乍一看,这是一项不可能完成的任务。但在花了几周时间了解 jsdoc 后,我看到了一些曙光。

恐怖类型系统:减速机

在某个点上,当我尝试编写一个reducer函数时,我发现了jsdoc能力的硬限制,结果是一个quack,但当然它启动了一个空的{}。因此,只有reducer运行结束时才创建了正确的quack,因为该类型对包含所有请求的键的对象感到好奇。所以这个问题到现在我都无法解决,如果有人能给我一个好主意,我该如何解决它,请与我分享或作为合作者加入这个模块开发。

另一个陷阱:没有 ts 的模块中没有类型

一开始我创建了一个 js 文件,其中包含所有必要的 jsdoc @typedef,迟早它会起作用。这就是我认为为他们创建节点模块的一步。
但可悲的事实是,包含导出类型的 npm 模块不能仅与 jsdoc 一起使用,因此必须编译 d.ts,因此最后 jsdoc 模块不要说 100% js,而是构建也使用 typescript

jsdoc-duck 模块中的@typedef

正如您在 dev.to 论坛中所认识到的,语法高亮无法识别 jsdoc。其他错误的事情在我的测试中,如果你只写一行,这个 @typedef 就会起作用,所以它违背了干净的代码。

在我的下一篇博文中,我将写的是这个库的具体用例,排序:使用 usereducer 简化和类型安全反应状态处理。

/**
 * @template T - Payload Type
 * @typedef {T extends { type: infer U, payload?: infer P } ? { type: U, payload?: P } : never} ActionType
 */

// @ts-ignore
/** @template AM - Actions Map @typedef {{ [K in AM['type']]: K }} Labels */

// @ts-ignore
/** @template AM - Actions Map @typedef {{ [T in AM["type"]]: Extract<am type: t> extends { payload: infer P } ? (payload: P) => void : () => void }} Quack */

/**
 * @template ST - State
 * @template AM - Actions Map
 * @typedef {(state: ST, action: AM) => ST} Reducer
 */
</am>

以上就是jsDoc npm 模块任务的详细内容,更多请关注其它相关文章!