当前位置:首页 > 文章列表 > 文章 > 前端 > jsDoc npm 模块任务

jsDoc npm 模块任务

来源:dev.to 2024-09-02 18:48:51 0浏览 收藏

知识点掌握了,还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战,手把手教大家学习《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 extends { payload: infer P } ? (payload: P) => void : () => void }} Quack */

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

本篇关于《jsDoc npm 模块任务》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于文章的相关知识,请关注golang学习网公众号!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
PHP 函数中如何使用递归来处理嵌套数据结构?PHP 函数中如何使用递归来处理嵌套数据结构?
上一篇
PHP 函数中如何使用递归来处理嵌套数据结构?
Win11怎么更改存储位置 Win11更改存储位置操作步骤
下一篇
Win11怎么更改存储位置 Win11更改存储位置操作步骤
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    367次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    425次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    441次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    390次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    216次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码