跳到正文

我所理解的 JavaScript 最佳实践(19):使用工具函数进行类型判断

我所理解的 JavaScript 最佳实践

  1. 使用现代化工具
  2. 尽量去掉只用一次的中间变量
  3. 遍历的起点决定按 ID 取数的顺序
  4. 不用 reduce
  5. 按遍历任务选择循环和数组方法
  6. 异步遍历按任务依赖选择并发或串行
  7. 卫语句让主流程保持平直
  8. 用函数给可复用的业务规则命名
  9. 让顺序无关的代码按名称排列
  10. 正确写注释
  11. 一行代码只做一件事
  12. 给函数起合适的名字
  13. 用空值合并运算符更好地控制默认值生效逻辑
  14. 用队列串行处理偏好更新,避免修改互相覆盖
  15. 确认弹窗关闭时,让等待中的 Promise 得到结果
  16. 用独立的预期值捕获实现错误
  17. 控制文件行数
  18. 控制函数圈复杂度和认知复杂度
  19. 使用工具函数进行类型判断(当前)
  20. 会演进的函数用对象参数
  21. 使用改进的原生 API
  22. 使用模板字符串优化多行文字展示
  23. 用查表取值,用 switch 分派动作
  24. 正确使用纯函数和副作用
  25. 避免数组空位
  26. 把条件写在可选元素和字段旁边
  27. 让独立条件各自表达

外观设置从 JSON 读回来时,先要判断它能不能当作一组字段读取。Marker 原来用的是 value && typeof value === 'object'。前面的真值判断挡住了 null,后面的条件仍会接受数组、Date 和类实例。外观设置实际只接受普通记录,所以入口用 isPlainObject,进入之后再判断每个字段的类型。

先确定需要哪一种对象

按 ECMAScript 的 typeof 规则,typeof null 返回 'object'。数组和大部分对象实例也得到 'object',函数则得到 'function'。加上 value !== null 只能排除空值。能否把值当普通记录读取,以及其中有哪些字段,仍要单独检查。

判断 null [] {} new Date() 普通函数
typeof value === 'object' 是 是 是 是 否
isObjectLike(value) 否 是 是 是 否
isPlainObject(value) 否 否 是 否 否
isObject(value) 否 是 是 是 是
Array.isArray(value) 否 是 否 否 否

表里的 isPlainObject 从 es-toolkit 根入口导入,也接受 Object.create(null) 创建的无原型记录。广义的 isObjectLike 和还接受函数的 isObject 来自 es-toolkit/compat。读配置、IPC 参数或接口记录时,通常先检查普通对象,再逐字段校验。把数组当列表处理时,用 Array.isArray。需要接受数组和实例时,才使用非空对象判断。

类型判断后再验证值能不能用

下面的示例沿用第一篇《使用现代化工具》里对新项目的选择,从 es-toolkit 根入口导入。已有 Lodash 或 lodash-es 的项目可以用库里对应的类型判断函数。示例按记录、字符串、数字和布尔值分别检查。开关传入 false 时会保留关闭状态,缩放值只有在是有限数字且处于约定范围内时才采用。

import { isBoolean, isNumber, isPlainObject, isString } from 'es-toolkit';

function readPreferences(input: unknown) {
  const value: Record<string, unknown> = isPlainObject(input) ? input : {};
  const zoom = value.zoom;
  return {
    title: isString(value.title) ? value.title.trim() : '',
    zoom: isNumber(zoom) && Number.isFinite(zoom) && zoom >= 80 && zoom <= 150 ? zoom : 100,
    showOutline: isBoolean(value.showOutline) ? value.showOutline : true,
  };
}

es-toolkit 的 isNumber 只判断运行时类型。isNumber(NaN) 和 isNumber(Infinity) 都为真。金额、尺寸、序号等字段还要按业务要求检查有限值、整数和范围。

同名函数也可能接受不同的值。Lodash 和 lodash-es 的 isString、isNumber、isBoolean 也接受相应的包装对象,例如 new String('标题')。输入协议只接受原始值时,要核对已有工具函数的契约,必要时用 typeof value === 'string' 这类原始类型判断。

输入协议只有 undefined 表示未传时,用 isUndefined 或显式比较。如果业务把 null 和 undefined 都当缺省值,可以用 isNil。false、0 和空字符串仍交给各字段的规则判断。

宿主全局的存在性仍用 typeof

同一份代码可能在浏览器和 Node.js 中运行。按 typeof 的求值规则,typeof window !== 'undefined' 在没有声明 window 时也可以求值。换成 !isUndefined(window) 则要先读取 window,变量缺失时会抛出 ReferenceError。宿主是否提供这个全局变量,和已声明变量的值是否为 undefined,需要用不同方式检查。

共享 ESLint 规则 @sheng/ts-prefer-es-toolkit-predicate 提示统一基础类型守卫。遇到 typeof value === 'object',规则会要求核对输入契约,代码需要按允许的对象种类来改。回归用例至少覆盖一项原本允许的合法值和一项容易误收的输入。例如配置记录除了测试普通对象,还要测试 null、数组以及字段类型错误。这样能同时验证类型判断和后续的字段约束。