【原创发布】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)联系我,也欢迎在评论区交流反馈~


相关推荐
就叫_这个吧9 小时前
Java递归方法实现面包屑导航
java·开发语言
fīɡЙtīиɡ ℡9 小时前
AI 应用系统设计
java·开发语言·人工智能
今天AI了吗11 小时前
Python 基础语法(一):常量、变量、输入输出与运算符
开发语言·数据库·人工智能·python·sql·深度学习·机器学习
kyriewen11 小时前
我把最常踩的8个CORS跨域报错整理了一遍——第8个去年还不存在
前端·javascript
TELL52111 小时前
selenium webdriver 第二次初始化的异常
开发语言·python
动词ing12 小时前
【C语言】自定义函数+指针入门
c语言·开发语言·算法
重生之后端学习12 小时前
283. 移动零[简单]✅
开发语言·数据结构·算法·leetcode·职场和发展
动词ing13 小时前
【C语言】结构体+文件基础
c语言·开发语言·数据结构
caimouse13 小时前
ReactOS 窗口系统分析(7):分层窗口与绘制辅助 — layered.c + draw.c
c语言·开发语言