TPower Design

Appearance

Return to top
On this page

类型断言

介绍

类型断言函数的集合

API

检查某个值的类型是否为给定type的类型

  • 类型
ts
function is(val: unknown, type: string) {
  return toString.call(val) === `[object ${type}]`
}

isDef

检查某个值是否不为undefined

  • 类型
ts
function isDef<T = unknown>(val?: T): val is T {
  return typeof val !== 'undefined'
}

isUnDef

检查某个值是否为undefined

  • 类型
ts
function isUnDef<T = unknown>(val?: T): val is T {
  return !isDef(val)
}

isObject

检查某个值是否为Object类型

  • 类型
ts
function isObject(val: any): val is Record<any, any> {
  return val !== null && is(val, 'Object')
}

isEmpty

检查某个值是否为空

  • 类型
ts
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
}

isDate

检查某个值是否为日期

  • 类型
ts
function isDate(val: unknown): val is Date {
  return is(val, 'Date')
}

isNull

检查某个值是否为null

  • 类型
ts
function isNull(val: unknown): val is null {
  return val === null
}

isNullAndUnDef

检查某个值是否不为undefined且为null

  • 类型
ts
function isNullAndUnDef(val: unknown): val is null | undefined {
  return isUnDef(val) && isNull(val)
}

isNullAndUnDef

检查某个值是否不为undefined或为null

  • 类型
ts
function isNullOrUnDef(val: unknown): val is null | undefined {
  return isUnDef(val) || isNull(val)
}

isNumber

检查某个值是否为Number类型

  • 类型
ts
function isNumber(val: unknown): val is number {
  return is(val, 'Number')
}

isPromise

检查某个值是否为Promise

  • 类型
ts
function isPromise<T = any>(val: unknown): val is Promise<T> {
  return is(val, 'Promise') && isObject(val) && isFunction(val.then) && isFunction(val.catch)
}

isString

检查某个值是否为String类型

  • 类型
ts
function isString(val: unknown): val is string {
  return is(val, 'String')
}

isFunction

检查某个值是否为函数

  • 类型
ts
function isFunction(val: unknown): val is Function {
  return typeof val === 'function'
}

isBoolean

检查某个值是否为Boolean类型

  • 类型
ts
function isBoolean(val: unknown): val is boolean {
  return is(val, 'Boolean')
}

isRegExp

检查某个值是否为一个RegExp表达式

  • 类型
ts
function isRegExp(val: unknown): val is RegExp {
  return is(val, 'RegExp')
}

isArray

检查某个值是否为数组

  • 类型
ts
function isArray(val: any): val is Array<any> {
  return val && Array.isArray(val)
}

isWindow

检查某个值是否为window对象

  • 类型
ts
function isWindow(val: any): val is Window {
  return typeof window !== 'undefined' && is(val, 'Window')
}

isElement

检查某个值是否为元素

  • 类型
ts
function isElement(val: unknown): val is Element {
  return isObject(val) && !!val.tagName
}

isMap

检查某个值是否为Map类型

  • 类型
ts
function isMap(val: unknown): val is Map<any, any> {
  return is(val, 'Map')
}

isUrl

检查某个值是否为符合正则条件的url

  • 类型
ts
function isUrl(path: string): boolean {
  const reg =
    /^(((^https?:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+(?::\d+)?|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?(\/#\/)?(?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[\w]*))?)$/
  return reg.test(path)
}

isEventListener

检查某个值是否为一个事件命名

  • 类型
ts
function isEventListener(val: string): boolean {
  const reg = /^on[A-Z]+/
  return reg.test(val)
}

isAndroid

检查当前浏览器的用户代理是否为Android

  • 类型
ts
const isAndroid = (): boolean => {
  return userAgent.indexOf('Android') > -1 || userAgent.indexOf('Adr') > -1 //android终端
}

isIOS

检查当前浏览器的用户代理是否为ios

  • 类型
ts
const isIOS = (): boolean => {
  return !!userAgent.match(/\(i[^;]+;( U;)? CPU.+Mac OS X/) //ios终端
}

detectOS

检查浏览器平台名

  • 类型
ts
function detectOS(): 'Linux' | 'Mac' | 'Unix' | 'Windows' | 'other' {
  const isWin = navigator.platform == 'Win32' || navigator.platform == 'Windows'
  const isMac =
    navigator.platform == 'Mac68K' ||
    navigator.platform == 'MacPPC' ||
    navigator.platform == 'Macintosh' ||
    navigator.platform == 'MacIntel'
  if (isMac) return 'Mac'
  const isUnix = navigator.platform == 'X11' && !isWin && !isMac
  if (isUnix) return 'Unix'
  const isLinux = String(navigator.platform).indexOf('Linux') > -1
  if (isLinux) return 'Linux'
  if (isWin) {
    return 'Windows'
  }