【原创发布】typechecker:一款轻量级 JS 模板化类型检查工具

【原创发布】typechecker:一款轻量级 JS 模板化类型检查工具

前言

在纯 JavaScript 开发中,我们常常面临类型不严谨导致的隐蔽 Bug,而引入 TypeScript 又会增加项目的学习和迁移成本。基于此,我开发了一款轻量级、无依赖的类型检查工具 @dongxiang678/typechecker,并已正式发布到 NPM 仓库,无需 TS 即可实现类 C++ 模板风格的强类型校验!

📦 包发布信息

✨ 核心作用

  1. 模板化类型约束 :模拟 C++ 模板 Checker<T> 风格,为任意类型创建专属检查器,杜绝类型混用;
  2. 函数类型强校验:强制校验函数入参和返回值类型,类型不匹配直接抛出明确错误;
  3. 支持自定义类:不仅支持 String/Number 等基础类型,还能对自定义类做精准类型校验;
  4. 轻量级无依赖:纯原生 JS 实现,体积仅 13KB,可无缝集成到任意 JS 项目(前端/Node.js)。

🚀 快速使用

1. 安装
bash 复制代码
# npm 安装
npm install @dongxiang678/typechecker --save

# yarn 安装
yarn add @dongxiang678/typechecker
2. 基础类型校验示例
javascript 复制代码
// 导入工具
const { createCheckerTemplate, enforceReturnType } = require('@dongxiang678/typechecker');

// 创建 String 类型检查器
const StringChecker = createCheckerTemplate(String);

// 强制函数返回 StringChecker 类型
const getValidString = enforceReturnType(StringChecker, (value) => {
  const checker = new StringChecker();
  return checker.check(value); // 仅接受 String 类型值
});

// 正常使用(返回 String 类型)
console.log(getValidString("Hello typechecker!").getValue()); // 输出:Hello typechecker!

// 类型错误示例(传入 Number 会直接报错)
try {
  getValidString(123);
} catch (err) {
  console.error(err.message); // 输出:返回值类型错误:Checker<Number> 无法转换为 Checker<String>
}
3. 自定义类校验示例
javascript 复制代码
const { createCheckerTemplate, enforceFunctionType } = require('@dongxiang678/typechecker');

// 自定义 User 类
class User {
  constructor(name) {
    this.name = name;
  }
}

// 创建 User 类型检查器
const UserChecker = createCheckerTemplate(User);

// 强制函数参数和返回值均为 UserChecker 类型
const getUserInfo = enforceFunctionType([UserChecker], UserChecker, (userChecker) => {
  return userChecker.check(new User("董翔"));
});

// 正常使用
const userChecker = new UserChecker(new User("测试用户"));
console.log(getUserInfo(userChecker).getValue().name); // 输出:董翔

🎯 适用场景

  • 纯 JS 项目的类型安全加固,避免因类型问题导致的隐蔽 Bug;
  • 团队协作项目中,强制规范函数入参/返回值类型;
  • 无需引入 TS,快速实现轻量级强类型校验;
  • 前端/Node.js 项目通用,无环境限制。

📄 开源协议

本工具采用 MIT 开源协议,可自由使用、修改、分发,欢迎各位开发者 Star/Fork 提优化建议!

最后

如果在使用过程中遇到问题,可通过 NPM 包主页的邮箱(3631247406@qq.com)联系我,也欢迎在评论区交流反馈~


相关推荐
devilnumber15 小时前
Java 递归算法 详解 + 核心要点 + 实战运用 + 避坑指南
java·开发语言·算法
asdfg125896317 小时前
JavaBean是什么?怎么理解?有什么用途?
java·开发语言
dsyyyyy110117 小时前
JavaScript变量
开发语言·javascript·ecmascript
kyriewen18 小时前
手写 Promise.all、race、any:不到 30 行代码,解决并发异步的所有姿势
前端·javascript·面试
z落落18 小时前
C#WinForm 窗体切换与窗体传值(登录跳转案例)+WinForm 窗体传值(从上往下传、从下往上传)
开发语言·windows·c#
allway218 小时前
How to Echo Multiline to a File in Bash [3 Methods]
开发语言·chrome·bash
weixin_4624462318 小时前
手把手教你用 Bash 脚本自动更新 /etc/hosts —— 自动绑定网卡 IP 与节点名
开发语言·tcp/ip·bash
一个梦醒了18 小时前
安装git bash选项推荐
开发语言·git·bash
ct97819 小时前
React 状态管理方案深度对比
开发语言·前端·react
胡志辉的博客19 小时前
深入浅出理解浏览器事件循环:从一道输出题讲到 Chrome 源码
前端·javascript·chrome·chromium·event loop