目前我正在工作/维护遗留的 js/react 应用程序,没有选项可以重新工作到 typesript,所以这就是为什么我打开 jsDoc 作为 JS 现有的开发时类型系统。
Typescript npm 模块由 jsDoc 制作,useDuck 在 70LOC 下带回了 redux 的黄金时代。该模块在开发时的主要用例,帮助您的复杂状态保持类型安全。
const [state, quack] = useDuck(reducer, initialState, actionsMap);
jsdoc-duck
当我创建了一个轻量级的 React State npm 库时,我对 TypeScript 的体验更加深入:react-state-factory
User declared state and actions types -> useStateFactory -> [state, dispatchedActoionCollection]
在我开始使用一些 jsDoc 注释来帮助我的工作之后,下一步有点更加大胆:将此模块重新设计为 jsDoc。乍一看,这是一项不可能完成的任务。但在花了几周时间了解 jsDoc 之后,我在tunel 的末尾看到了一些曙光。
在某个点下,当我尝试编写一个reducer函数时,我发现了jsDoc功能的硬限制,其结果是一个Quack,但当然它正在启动一个空的{}。因此,只有reducer运行结束时才创建了正确的Quack,因为该类型对包含所有请求的键的对象感到好奇。所以这个问题到现在我都无法解决,如果有人能给出一个好主意,我该如何解决它,请与我分享或作为合作者加入这个模块开发。
首先,我创建一个 js 文件,其中包含所有必要的 jsDoc @typedef,迟早这会起作用。这就是我认为为他们创建节点模块的一步。
但可悲的事实是,包含导出类型的 npm 模块不能仅与 jsDoc 一起使用,因此必须编译 d.ts,因此最后 jsDoc 模块不要说 100% JS,而是构建也使用 typescript。
正如您在 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"]]: Extractextends { payload: infer P } ? (payload: P) => void : () => void }} Quack */ /** * @template ST - State * @template AM - Actions Map * @typedef {(state: ST, action: AM) => ST} Reducer */
免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。
Copyright© 2022 湘ICP备2022001581号-3