ES-Toolkit 中实现 Window 对象类型检查的最佳实践
2025-05-28 21:26:57作者:宣聪麟
在现代前端开发中,类型安全和环境检测是构建健壮应用的关键。es-toolkit 作为一个实用的 JavaScript/TypeScript 工具库,近期社区讨论了一个关于增加 isWindow
类型检查工具函数的有趣建议。
为什么需要 isWindow 函数
在前端开发中,我们经常需要处理与窗口和 DOM 元素相关的逻辑。特别是在处理滚动事件、尺寸计算等场景时,代码可能需要同时支持 Window 对象和普通 DOM 元素作为参数。这时候,一个可靠的类型检查函数就显得尤为重要。
传统的做法可能是直接比较 element === window
,但这种简单比较存在几个问题:
- 在非浏览器环境(如 SSR)下会报错
- 缺乏 TypeScript 的类型保护
- 代码可读性较差
isWindow 的实现方案
es-toolkit 社区提出的实现方案既简洁又全面:
export function isWindow(element: unknown): element is Window {
if (!isBrowser()) {
return false;
}
return element === window;
}
这个实现有几个值得注意的技术点:
- 首先检查是否在浏览器环境中,避免 SSR 场景下的报错
- 使用 TypeScript 的类型谓词(type predicate)
element is Window
提供类型保护 - 复用现有的
isBrowser
工具函数,保持代码一致性
实际应用场景
这个工具函数在以下场景特别有用:
1. 滚动位置获取
function getScrollPosition(element: HTMLElement | Window) {
if (isWindow(element)) {
// 这里 element 被类型推断为 Window
return { x: element.scrollX, y: element.scrollY };
}
// 这里 element 被类型推断为 HTMLElement
return { x: element.scrollLeft, y: element.scrollTop };
}
2. 事件监听处理
function addScrollListener(target: HTMLElement | Window, handler: () => void) {
if (isWindow(target)) {
target.addEventListener('scroll', handler);
} else {
target.addEventListener('scroll', handler, { passive: true });
}
}
与 isBrowser 的区别
虽然 es-toolkit 已经提供了 isBrowser
函数,但两者解决的问题不同:
isBrowser
: 检测当前运行时环境是否为浏览器isWindow
: 检测特定变量是否为 Window 对象并提供类型保护
总结
isWindow
是一个小而美的工具函数,它体现了 TypeScript 类型系统的强大之处,也展示了 es-toolkit 对开发者体验的关注。通过简单的类型谓词,我们能够写出更安全、更易维护的前端代码。这个建议已经被社区接受并即将实现,相信会成为 es-toolkit 中又一个实用的工具函数。
登录后查看全文
热门项目推荐
相关项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0370Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++099AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
203
2.18 K

React Native鸿蒙化仓库
C++
208
285

Ascend Extension for PyTorch
Python
62
94

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
84

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27

前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
1.2 K
133