ES-Toolkit 中实现 Window 对象类型检查的最佳实践

在现代前端开发中，类型安全和环境检测是构建健壮应用的关键。es-toolkit 作为一个实用的 JavaScript/TypeScript 工具库，近期社区讨论了一个关于增加 isWindow 类型检查工具函数的有趣建议。

为什么需要 isWindow 函数

在前端开发中，我们经常需要处理与窗口和 DOM 元素相关的逻辑。特别是在处理滚动事件、尺寸计算等场景时，代码可能需要同时支持 Window 对象和普通 DOM 元素作为参数。这时候，一个可靠的类型检查函数就显得尤为重要。

传统的做法可能是直接比较 element === window，但这种简单比较存在几个问题：

1. 在非浏览器环境（如 SSR）下会报错
2. 缺乏 TypeScript 的类型保护
3. 代码可读性较差

isWindow 的实现方案

es-toolkit 社区提出的实现方案既简洁又全面：

export function isWindow(element: unknown): element is Window {
  if (!isBrowser()) {
    return false;
  }
  return element === window;
}

这个实现有几个值得注意的技术点：

1. 首先检查是否在浏览器环境中，避免 SSR 场景下的报错
2. 使用 TypeScript 的类型谓词（type predicate）element is Window 提供类型保护
3. 复用现有的 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 中又一个实用的工具函数。