TypeScript 中的类型检查实用函数

TypeScript 中的类型检查实用函数

一、概述

在前端开发中，我们经常需要判断变量的类型以进行相应的操作或处理。TypeScript 提供了基础的类型检查，但有时我们需要更复杂或更灵活的类型检查。这篇博客文章将介绍一组实用函数，用于各种常见的类型检查。

二、代码实现

// 禁用一些 ESLint 规则，主要是因为下面使用了 Object.prototype 的方法
// eslint-disable-next-line @typescript-eslint/unbound-method
const { toString } = Object.prototype

// 判断一个值是否为指定类型
export function is(val: unknown, type: string) {
  return toString.call(val) === `[object ${type}]`
}

// 判断一个值是否已定义
export function isDef<T = unknown>(val?: T): val is T {
  return typeof val !== 'undefined'
}

// 判断一个值是否未定义
export function isUnDef<T = unknown>(val?: T): val is T {
  return !isDef(val)
}

// 判断一个值是否是对象
export function isObject(val: any): val is Record<any, any> {
  return val !== null && is(val, 'Object')
}

// 判断一个值是否为空
export function isEmpty<T = unknown>(val: T): val is T {
  if (isArray(val) || isString(val)) return val.length === 0
  if (val instanceof Map || val instanceof Set) return val.size === 0
  if (isObject(val)) return Object.keys(val).length === 0
  return false
}

// 判断一个值是否是日期对象
export function isDate(val: unknown): val is Date {
  return is(val, 'Date')
}

// 判断一个值是否是 null
export function isNull(val: unknown): val is null {
  return val === null
}

// 判断一个值是否是 null 或 undefined
export function isNullOrUnDef(val: unknown): val is null | undefined {
  return isUnDef(val) || isNull(val)
}

// 判断一个值是否是数字
export function isNumber(val: unknown): val is number {
  return is(val, 'Number')
}

// 判断一个值是否是 Promise
export function isPromise<T = any>(val: unknown): val is Promise<T> {
  return is(val, 'Promise') && isObject(val) && isFunction(val.then) && isFunction(val.catch)
}

// 判断一个值是否是字符串
export function isString(val: unknown): val is string {
  return is(val, 'String')
}

// 判断一个值是否是函数
export function isFunction(val: unknown): val is Function {
  return typeof val === 'function'
}

// 判断一个值是否是布尔值
export function isBoolean(val: unknown): val is boolean {
  return is(val, 'Boolean')
}

// 判断一个值是否是正则表达式
export function isRegExp(val: unknown): val is RegExp {
  return is(val, 'RegExp')
}

// 判断一个值是否是数组
export function isArray(val: any): val is Array<any> {
  return !!val && Array.isArray(val)
}

// 判断一个值是否是 Window 对象
export function isWindow(val: any): val is Window {
  return typeof window !== 'undefined' && is(val, 'Window')
}

// 判断一个值是否是 DOM 元素
export function isElement(val: unknown): val is Element {
  return isObject(val) && !!val.tagName
}

// 判断一个值是否是 Map 对象
export function isMap(val: unknown): val is Map<any, any> {
  return is(val, 'Map')
}

// 判断当前环境是否是服务器
export const isServer = typeof window === 'undefined'

// 判断当前环境是否是客户端
export const isClient = !isServer

// 判断一个字符串是否是有效的 URL
export function isUrl(path: string): boolean {
  const reg = /^((https|http|ftp|rtsp|mms):\/\/)(([0-9a-zA-Z_!~*'().&=+$%-]+: )?[0-9a-zA-Z_!~*'().&=+$%-]+@)?(([0-9]{1,3}.){3}[0-9]{1,3}|([0-9a-zA-Z_!~*'()-]+.)*([0-9a-zA-Z][0-9a-zA-Z-]{0,61})?[0-9a-zA-Z].[a-zA-Z]{2,6})(:[0-9]{1,4})?((\/?)|(\/[0-9a-zA-Z_!~*'().;?:@&=+$,%#-]+)+\/?)$/
  return reg.test(path)
}