Skip to content
On this page

介绍

封装的常用的js工具函数,如果你使用的是typescript也可以直接使用。

安装

使用 npm

npm install @nw-design/utils -S

使用 yarn

yarn add @nw-design/utils

使用 pnpm

pnpm add @nw-design/utils -S

使用

提供了CommonJS和ES6 Module两种模块 该组件类似于element-ui中的el-scrollbar,用于自定义滚动条组件。

TIP

建议:优先使用lodash-es, dayjs, @vueuse/core中已有的方法。

CommonJS使用

ts
const nwUtils = require('@nw-design/utils')

ES6使用

ts
import { is } from '@nw-design/utils'

isServer

是否是服务器环境,如果是返回true, 否则返回false

isClient

是否是浏览器环境,如果是返回true, 否则返回false

isMobile

isMobile(): boolean

判断是否是在移动端手机浏览器

isWeiXin

isWeiXin(): boolean

判断是否是在移动端微信浏览器浏览器

参数

isExternal

isExternal(val:string): boolean

判断是否是外部链接

参数

  1. val(string) 需要验证的值

返回值
(boolean)是外部链接返回true,否则false

例子

ts
const a = 'https://www.baidu.com/';
isExternal(a)
// => true

返回值
(boolean)如果是在微信浏览器那么返回true, 否则返回false

validatorPhone

validatorPhone(val: unknown): boolean

判断是否是手机号

参数

  1. val(unknown) 需要验证的值

返回值
(boolean)是手机号码返回true,否则false

例子

ts
const a = '18702513936';
validatorPhone(a)
// => true
const b= '123'
validatorPhone(b)
// => false

validatorIdCard

validatorIdCard(val: unknown): boolean

判断是否是为身份证号码

参数

  1. val(unknown) 需要验证的值

返回值
(boolean)是身份证号码返回true,否则false

validatorCarCard

validatorCarCard(val: unknown): boolean

判断是否是为车牌号码

参数

  1. val(unknown) 需要验证的值

返回值
(boolean)是车牌号码返回true,否则false

validatorIdCard

validatorIdCard(val: unknown): boolean

判断是否是为身份证号码

参数

  1. val(unknown) 需要验证的值

返回值
(boolean)是身份证号码返回true,否则false

buildUUID

buildUUID(): string

生成UUID

参数

返回值
(string)返回生成的uuid字符串

buildShortUUID

buildShortUUID(prefix?: ''): string

生成简单的uuid

参数

  1. prefix(string)(可选) 前缀

返回值
(string)返回生成的uuid字符串

getBase64

getBase64(file: File): Promise

将File文件转成base64字符串

参数

  1. file(File) 文件

返回值
返回Promise

downloadByUrl

downloadByUrl({
  url,
  target = '_blank',
  fileName
}: {
  url: string
  target?: string
  fileName?: string
}): boolean

直接根据文件地址下载文件

参数

  1. opt ({ url: string target?: string fileName?: string})

返回值
返回boolean, 不支持download返回false

downloadByData

downloadByData(data: Blob, filename: string, mime?: string): void

如果后台返回的是Blob,调用该方法下载文件

参数

  1. data(Blob)
  2. filename(string) 文件名
  3. mime(string) 媒体类型

返回值
返回boolean, 不支持download返回false

Last updated: