fq-utils / Exports

# fq-utils

# Table of contents

# Enumerations

# Interfaces

# Type Aliases

# 【常量】

# Type Aliases

# baseType

Description

js包含的基础数据类型

# Defined in

interface.ts:39 (opens new window)

# dateType

Ƭ dateType: Date | strOrNumType

Description

日期常用格式类型

# Defined in

interface.ts:12 (opens new window)

# strOrNumType

Ƭ strOrNumType: string | number

Description

字符串或数字类型

# Defined in

interface.ts:5 (opens new window)

# 【常量】

# DATA_LIMIT_NUMBER

• Const DATA_LIMIT_NUMBER: dateInterFace

Description

日期临界值映射关系

# Defined in

date.ts:130 (opens new window)

# DATA_UNIT

• Const DATA_UNIT: dateInterFace

Description

日期单位映射关系

# Defined in

date.ts:116 (opens new window)

# 校验内容格式【reg】

# checkValueFormat

▸ checkValueFormat(val, type?): boolean

# Parameters

Name	Type	Default value	Description
`val`	`any`	`undefined`	传入的内容
`type`	`string`	`'mobile'`	要校验的类型

# Returns

boolean

是否符合格式

# Defined in

reg.ts:23 (opens new window)

# 正则表达式合集【reg】

# checkExp

• Const checkExp: Object

# Type declaration

Name	Type
`decimal`	`RegExp`
`email`	`RegExp`
`idChard`	`RegExp`
`identifier`	`RegExp`
`mobile`	`RegExp`
`password`	`RegExp`

# Defined in

reg.ts:7 (opens new window)

# Variables

# fileTypeObj

• Const fileTypeObj: Object

Description

文件类型映射表

# Type declaration

Name	Type
`7z`	`string`
`avi`	`string`
`bmp`	`string`
`doc`	`string`
`docx`	`string`
`flv`	`string`
`gif`	`string`
`jpeg`	`string`
`jpg`	`string`
`m2v`	`string`
`m4v`	`string`
`mkv`	`string`
`mov`	`string`
`mp3`	`string`
`mp4`	`string`
`pdf`	`string`
`png`	`string`
`ppt`	`string`
`pptx`	`string`
`rar`	`string`
`rmvb`	`string`
`wav`	`string`
`wma`	`string`
`wmv`	`string`
`xls`	`string`
`xlsx`	`string`
`zip`	`string`

# Defined in

file.ts:20 (opens new window)

# base64加密【file】

# base64Encode

▸ base64Encode(params): string

# Parameters

Name	Type	Description
`params`	`string`	传入的内容

# Returns

string

base64加密后的内容

# Defined in

file.ts:159 (opens new window)

# base64解密【file】

# base64Decode

▸ base64Decode(params): string

# Parameters

Name	Type	Description
`params`	`string`	传入的内容

# Returns

string

base64解密后的内容

# Defined in

file.ts:172 (opens new window)

# base64转blob 【file】

# base64ToBlob

▸ base64ToBlob(params, type?): Blob

# Parameters

Name	Type	Description
`params`	`string`	传入的内容
`type?`	`string`	blob的类型，非必填，如果不填，则根据params中获取，获取不到，则为undefined

# Returns

Blob

返回blob

# Defined in

file.ts:186 (opens new window)

# blob转base64，或者file转base64 【file】

# blobOrFileToBase64

▸ blobOrFileToBase64(params): Promise<string | ArrayBuffer>

# Parameters

Name	Type	Description
`params`	`Blob` \| `File`	传入的内容

# Returns

Promise<string | ArrayBuffer>

# Defined in

file.ts:217 (opens new window)

# 是否是File 【file】

# isFile

▸ isFile(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的内容

# Returns

boolean

# Defined in

file.ts:12 (opens new window)

# 是否是blob 【file】

# isBlob

▸ isBlob(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的内容

# Returns

boolean

# Defined in

file.ts:149 (opens new window)

# 格式化文件size 【file】

# formatFileSize

▸ formatFileSize(params): string

# Parameters

Name	Type	Description
`params`	`formatFileSizeInterface`	文件size大小

# Returns

string

格式化后的文件size

# Defined in

file.ts:116 (opens new window)

# 获取文件类型【根据文件名、或File对象的type字段】【file】

# getFileType

▸ getFileType(fileName, onlySuffix?): string

# Parameters

Name	Type	Default value	Description
`fileName`	`string`	`undefined`	文件名，或File对象的type字段
`onlySuffix`	`boolean`	`false`	是否只返回后缀名称

# Returns

string

文件类型

# Defined in

file.ts:80 (opens new window)

# 向localStorage中存入数据【storage】

# setStorage

▸ setStorage(key, value, expire?, containType?): void

# Parameters

Name	Type	Default value	Description
`key`	`string`	`undefined`	存储数据的key
`value`	`baseType`	`undefined`	存入的数据
`expire`	`dateType`	`365`	过期时间，可以传天数或过期时间，默认365天（单位：天），
`containType`	`boolean`	`true`	是否存入数据类型

# Returns

void

# Defined in

storage.ts:71 (opens new window)

# 清除localStorage 【storage】

# clearStorage

▸ clearStorage(): void

# Returns

void

# Defined in

storage.ts:106 (opens new window)

# 移除localStorage中的值【storage】

# removeStorage

▸ removeStorage(key): void

# Parameters

Name	Type	Description
`key`	`string`	要移除的存储数据key

# Returns

void

# Defined in

storage.ts:94 (opens new window)

# 获取localstorage中的存储的数据【storage】

# getStorage

▸ getStorage(key): baseType

# Parameters

Name	Type	Description
`key`	`string`	存储数据的key

# Returns

baseType

返回获取到的value值

# Defined in

storage.ts:24 (opens new window)

# 修正字符串或数字的长度【public】

# reviseLength

▸ reviseLength<T>(params, len, fillText?, startPosition?): strOrNumType

# Type parameters

Name	Type
`T`	extends `strOrNumType`

# Parameters

Name	Type	Default value	Description
`params`	`T`	`undefined`	传入的字符串或数字
`len`	`number`	`undefined`	修正后的长度
`fillText`	`string`	`'0'`	修正时填充用的字符
`startPosition`	`StartPositionEnum`	`StartPositionEnum.END`	从什么位置开始填充

# Returns

strOrNumType

返回修正后的字符串或数字

# Defined in

common.ts:22 (opens new window)

# 函数节流【public】

# throttle

▸ throttle(delay, noTrailing, callback?, debounceMode?): Function

# Parameters

Name	Type	Description
`delay`	`number`	延时时间
`noTrailing`	`boolean` \| `Function`
`callback?`	`boolean` \| `Function`	回调函数
`debounceMode?`	`boolean` \| `Function`	是否立即执行

# Returns

Function

返回的节流函数

# Defined in

common.ts:123 (opens new window)

# 函数防抖【public】

# debounce

▸ debounce(delay, atBegin, callback?): Function

# Parameters

Name	Type	Description
`delay`	`number`	延时时间
`atBegin`	`boolean` \| `Function`	是否立即触发
`callback?`	`Function`	回调函数

# Returns

Function

返回防抖函数

# Defined in

common.ts:188 (opens new window)

# 判断是否是null 【public】

# isNull

▸ isNull(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的数据

# Returns

boolean

返回是否是null

# Defined in

common.ts:51 (opens new window)

# 判断是否是undefined 【public】

# isUndefined

▸ isUndefined(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的数据

# Returns

boolean

返回是否是undefined

# Defined in

common.ts:61 (opens new window)

# 判断是否是空（空字符串\null\undefined）【public】

# isEmpty

▸ isEmpty(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的数据

# Returns

boolean

返回是否是空

# Defined in

common.ts:71 (opens new window)

# 复制到剪贴板【public】

# copyToClipboard

▸ copyToClipboard(textToCopy): Promise<boolean>

# Parameters

Name	Type	Description
`textToCopy`	`string`	要复制的文字

# Returns

Promise<boolean>

# Defined in

common.ts:227 (opens new window)

# 对象转为url格式【public】

# objToUrl

▸ objToUrl(params, firstStr?, separator?, filterFunction?): string

# Parameters

Name	Type	Default value	Description
`params`	`object`	`undefined`	对象格式
`firstStr`	`string`	`'?'`	第一个字符，默认为：?
`separator`	`string`	`'&'`	分隔符，默认为：&
`filterFunction?`	`Function`	`undefined`	自定义过滤函数

# Returns

string

返回的url

# Defined in

common.ts:289 (opens new window)

# 获取序列化字符串中的参数，默认返回全部参数的对象格式【public】

# getQueryParams

▸ getQueryParams(params, searchUrl?): string | object

# Parameters

Name	Type	Description
`params`	`string`	需要查询的key
`searchUrl?`	`string`	字符串，默认为location.search

# Returns

string | object

返回对应key的value，默认返回key、value键值对的对象格式

# Defined in

common.ts:251 (opens new window)

# 获取数据类型【public】

# getDataType

▸ getDataType(data, caseType?): string

# Parameters

Name	Type	Default value	Description
`data`	`any`	`undefined`	传入的数据
`caseType`	`CASE_TYPE`	`CASE_TYPE.LOWER`	返回的字符串全部小写、或全部大写

# Returns

string

返回数据类型字符串

# Defined in

common.ts:40 (opens new window)

# 转换基础数据类型【public】

# transfromDataType

▸ transfromDataType<T>(params, targetType): string | number | boolean | object | any[]

# Type parameters

Name	Type
`T`	extends `string` \| `number` \| `boolean` \| `object` \| `any`[]

# Parameters

Name	Type	Description
`params`	`baseType`	要转换的数据
`targetType`	`T`	-

# Returns

string | number | boolean | object | any[]

转换后的数据

# Defined in

common.ts:82 (opens new window)

# 判断日期是否比目标日期小【date】

# isLessThanTargetDate

▸ isLessThanTargetDate(compareDate, targetDate?): boolean

# Parameters

Name	Type	Description
`compareDate`	`dateType`	要比较的日期
`targetDate`	`dateType`	目标日期

# Returns

boolean

是否比目标日期小

# Defined in

date.ts:206 (opens new window)

# 判断是否是日期格式的数据【date】

# isDate

▸ isDate(date): boolean

# Parameters

Name	Type	Description
`date`	`any`	传入的数据

# Returns

boolean

是否是日期格式的数据

# Defined in

date.ts:12 (opens new window)

# 格式化日期【date】

# formatDate

▸ formatDate(time, format?, fillZero?): string

# Parameters

Name	Type	Default value	Description
`time`	`dateType`	`undefined`	要进行格式化的日期数据
`format`	`string`	`'YYYY-MM-DD HH:mm:ss'`	格式
`fillZero`	`boolean`	`true`	是否自动补零，默认自动补零

# Returns

string

格式化后的日期

# Defined in

date.ts:82 (opens new window)

# 获取两个日期之差【date】

# getTimeDiff

▸ getTimeDiff(firstDate, secondDate?): number

# Parameters

Name	Type	Description
`firstDate`	`dateType`	第一个日期
`secondDate`	`dateType`	第二个日期，默认当前时间

# Returns

number

返回两个日期相差的时间

# Defined in

date.ts:193 (opens new window)

# 获取两个日期之差（绝对值）【date】

# getTimeDiffAbs

▸ getTimeDiffAbs(firstDate, secondDate?, returnType?): strOrNumType | dateInterFace

# Parameters

Name	Type	Default value	Description
`firstDate`	`dateType`	`undefined`	第一个日期
`secondDate`	`dateType`	`undefined`	第二个日期，默认当前时间
`returnType`	`DateTimeDiffType`	`DateTimeDiffType.STRING`	返回数据的类型

# Returns

strOrNumType | dateInterFace

返回两个日期相差的时间

# Defined in

date.ts:157 (opens new window)

# 获取年龄大小【date】

# getAge

▸ getAge(birthDay, comparePrecision?): number

# Parameters

Name	Type	Default value	Description
`birthDay`	`dateType`	`undefined`	出生日期
`comparePrecision`	`ageComparePrecision`	`ageComparePrecision.year`	-

# Returns

number

返回年龄

# Defined in

date.ts:360 (opens new window)

# 获取日期展示文案【date】

# getDateText

▸ getDateText(参数): string

# Parameters

Name	Type
`参数`	`dateTextInterface`

# Returns

string

处理后的日期展示文案

# Defined in

date.ts:252 (opens new window)

# 获取某个月有多少天【date】

# getDaysOfMonth

▸ getDaysOfMonth(targetDate?): number

# Parameters

Name	Type	Description
`targetDate`	`dateType`	目标日期

# Returns

number

返回天数

# Defined in

date.ts:324 (opens new window)

# 获取格林威治时间【date】

# getDate

▸ getDate(date): Date

# Parameters

Name	Type	Description
`date`	`dateType`	传入日期

# Returns

Date

格林威治时间

# Defined in

date.ts:45 (opens new window)

# 获取目标日期N天后或N天前的日期【date】

# getDateAfterDay

▸ getDateAfterDay(day, targetDate?, format?): string

# Parameters

Name	Type	Default value	Description
`day`	`number`	`undefined`	天数【可正可负】，如果为负数，则为N天前的日期
`targetDate`	`dateType`	`undefined`	目标日期
`format`	`string`	`'YYYY-MM-DD'`	日期格式

# Returns

string

格式化后的N天后的日期

# Defined in

date.ts:338 (opens new window)

# 获取目标日期零点的时间戳【date】

# getZeroEndTimeStamp

▸ getZeroEndTimeStamp(targetDate?, returnStamp?): dateType

# Parameters

Name	Type	Default value	Description
`targetDate`	`dateType`	`undefined`	目标日期
`returnStamp`	`boolean`	`true`	-

# Returns

dateType

返回目标日期零点的时间戳

# Defined in

date.ts:216 (opens new window)

# 保留小数【number】

# numberToFiexd

▸ numberToFiexd(params, decimalNum?): number

# Parameters

Name	Type	Default value	Description
`params`	`number`	`undefined`	传入的数字
`decimalNum`	`number`	`2`	小数位数，默认两位

# Returns

number

保留小数后的位数

# Defined in

number.ts:40 (opens new window)

# 判断是否是number（纯数字字符串也算number）【number】

# isNumber

▸ isNumber(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的内容

# Returns

boolean

是否是number

# Defined in

number.ts:10 (opens new window)

# 数字增加千分位【number】

# numberAddThousandSeparator

▸ numberAddThousandSeparator(params, decimalNum?): string

# Parameters

Name	Type	Default value	Description
`params`	`number`	`undefined`	传入的数字
`decimalNum`	`number`	`0`	小数位数，默认0位

# Returns

string

增加千分位后的数字

# Defined in

number.ts:54 (opens new window)

# 数字小于10进行自动补零【number】

# padNumber

▸ padNumber(params): string

# Parameters

Name	Type	Description
`params`	`number`	要补零的数字

# Returns

string

补零后的数字

# Defined in

number.ts:23 (opens new window)

# 格式化数字【number】

# formatNumber

▸ formatNumber(params, decimalNum?, needThousandSeparator?): strOrNumType

# Parameters

Name	Type	Default value	Description
`params`	`number`	`undefined`	传入的数字
`decimalNum`	`number`	`2`	小数位数，默认2位
`needThousandSeparator`	`boolean`	`false`	是否需要增加千分位

# Returns

strOrNumType

格式化后的数字【如果增加千分位，则返回string】

# Defined in

number.ts:68 (opens new window)

# 获取数字的长度【number】

# getNumberLength

▸ getNumberLength(params): number

# Parameters

Name	Type	Description
`params`	`number`	传入的数字

# Returns

number

数字的长度

# Defined in

number.ts:31 (opens new window)

# 是否是数组【array】

# isArray

▸ isArray(params, num?): boolean

# Parameters

Name	Type	Default value	Description
`params`	`any`	`undefined`	传入的内容
`num`	`number`	`-1`	数组长度是否超过该数值

# Returns

boolean

是否是数组

# Defined in

array.ts:10 (opens new window)

# 根据数字得到数组【array】

# getArrayFromNumber

▸ getArrayFromNumber(params): number[]

# Parameters

Name	Type	Description
`params`	`number`	传入的数字

# Returns

number[]

返回的数组

# Defined in

array.ts:23 (opens new window)

# 是否PC端微信浏览器【brower】

# isPcWeixin

▸ isPcWeixin(): boolean

# Returns

boolean

# Defined in

brower.ts:104 (opens new window)

# 是否是Edg浏览器【brower】

# isEdg

▸ isEdg(): boolean

# Returns

boolean

# Defined in

brower.ts:59 (opens new window)

# 是否是Firefox浏览器【brower】

# isFirefox

▸ isFirefox(): boolean

# Returns

boolean

# Defined in

brower.ts:77 (opens new window)

# 是否是IE浏览器【brower】

# isIE

▸ isIE(): boolean

# Returns

boolean

# Defined in

brower.ts:50 (opens new window)

# 是否是safari浏览器【brower】

# isSafari

▸ isSafari(): boolean

# Returns

boolean

# Defined in

brower.ts:68 (opens new window)

# 是否是微信浏览器【brower】

# isWeixin

▸ isWeixin(): boolean

# Returns

boolean

# Defined in

brower.ts:86 (opens new window)

# 是否是移动端微信浏览器【brower】

# isMobileWeixin

▸ isMobileWeixin(): boolean

# Returns

boolean

# Defined in

brower.ts:95 (opens new window)

# 是否有window对象【brower】

# hasWindow

▸ hasWindow(): boolean

# Returns

boolean

# Defined in

brower.ts:125 (opens new window)

# 是否移动端浏览器【brower】

# isMobile

▸ isMobile(): boolean

# Returns

boolean

# Defined in

brower.ts:113 (opens new window)

# 获取浏览器类型【brower】

# getBrowerType

▸ getBrowerType(): "unknown" | browerType

# Returns

"unknown" | browerType

# Defined in

brower.ts:21 (opens new window)

# 字符串加密处理【string】

# stringEncry

▸ stringEncry(__namedParameters): string

# Parameters

Name	Type
`__namedParameters`	`stringEncryInterface`

# Returns

string

返回加密后的字符串

# Defined in

string.ts:50 (opens new window)

# 是否是字符串【string】

# isString

▸ isString(params): boolean

# Parameters

Name	Type	Description
`params`	`any`	传入的内容

# Returns

boolean

返回是否是字符串

# Defined in

string.ts:10 (opens new window)

# 根据对象及映射字段，得到一个拼接后的字符串【string】

# getStringFromObj

▸ getStringFromObj<T>(dataObj, unitObj): string

# Type parameters

Name	Type
`T`	extends `object`

# Parameters

Name	Type
`dataObj`	`T`
`unitObj`	`T`

# Returns

string

返回拼接后的字符串

# Defined in

string.ts:21 (opens new window)

# fq-utils

# Table of contents

# Enumerations

# Interfaces

# Type Aliases

# 【常量】

# 校验内容格式 【reg】

# 正则表达式合集 【reg】

# Variables

# base64加密 【file】

# base64解密 【file】

# base64转blob 【file】

# blob转base64，或者file转base64 【file】

# 是否是File 【file】

# 是否是blob 【file】

# 格式化文件size 【file】

# 获取文件类型【根据文件名、或File对象的type字段】 【file】

# 向localStorage中存入数据 【storage】

# 清除localStorage 【storage】

# 移除localStorage中的值 【storage】

# 获取localstorage中的存储的数据 【storage】

# 修正字符串或数字的长度 【public】

# 函数节流 【public】

# 函数防抖 【public】

# 判断是否是null 【public】

# 判断是否是undefined 【public】

# 判断是否是空（空字符串\null\undefined） 【public】

# 复制到剪贴板 【public】

# 对象转为url格式 【public】

# 获取序列化字符串中的参数，默认返回全部参数的对象格式 【public】

# 获取数据类型 【public】

# 转换基础数据类型 【public】

# 判断日期是否比目标日期小 【date】

# 判断是否是日期格式的数据 【date】

# 格式化日期 【date】

# 获取两个日期之差 【date】

# 获取两个日期之差（绝对值） 【date】

# 获取年龄大小 【date】

# 获取日期展示文案 【date】

# 获取某个月有多少天 【date】

# 获取格林威治时间 【date】

# 获取目标日期N天后或N天前的日期 【date】

# 获取目标日期零点的时间戳 【date】

# 保留小数 【number】

# 判断是否是number（纯数字字符串也算number） 【number】

# 数字增加千分位 【number】

# 数字小于10进行自动补零 【number】

# 格式化数字 【number】

# 获取数字的长度 【number】

# 是否是数组 【array】

# 根据数字得到数组 【array】

# 是否PC端微信浏览器 【brower】

# 是否是Edg浏览器 【brower】

# 是否是Firefox浏览器 【brower】

# 是否是IE浏览器 【brower】

# 是否是safari浏览器 【brower】

# 是否是微信浏览器 【brower】

# 是否是移动端微信浏览器 【brower】

# 是否有window对象 【brower】

# 是否移动端浏览器 【brower】

# 获取浏览器类型 【brower】

# 字符串加密处理 【string】

# 是否是字符串 【string】

# 根据对象及映射字段，得到一个拼接后的字符串 【string】

# Type Aliases

# baseType

# Defined in

# dateType

# Defined in

# strOrNumType

# Defined in

# 【常量】

# DATA_LIMIT_NUMBER

# Defined in

# DATA_UNIT

# Defined in

# 校验内容格式 【reg】

# checkValueFormat

# Parameters

# Returns

# 校验内容格式【reg】

# 正则表达式合集【reg】

# base64加密【file】

# base64解密【file】

# 获取文件类型【根据文件名、或File对象的type字段】【file】

# 向localStorage中存入数据【storage】

# 移除localStorage中的值【storage】

# 获取localstorage中的存储的数据【storage】

# 修正字符串或数字的长度【public】

# 函数节流【public】

# 函数防抖【public】

# 判断是否是空（空字符串\null\undefined）【public】

# 复制到剪贴板【public】

# 对象转为url格式【public】

# 获取序列化字符串中的参数，默认返回全部参数的对象格式【public】

# 获取数据类型【public】

# 转换基础数据类型【public】

# 判断日期是否比目标日期小【date】

# 判断是否是日期格式的数据【date】

# 格式化日期【date】

# 获取两个日期之差【date】

# 获取两个日期之差（绝对值）【date】

# 获取年龄大小【date】

# 获取日期展示文案【date】

# 获取某个月有多少天【date】

# 获取格林威治时间【date】

# 获取目标日期N天后或N天前的日期【date】

# 获取目标日期零点的时间戳【date】

# 保留小数【number】

# 判断是否是number（纯数字字符串也算number）【number】

# 数字增加千分位【number】

# 数字小于10进行自动补零【number】

# 格式化数字【number】

# 获取数字的长度【number】

# 是否是数组【array】

# 根据数字得到数组【array】

# 是否PC端微信浏览器【brower】

# 是否是Edg浏览器【brower】

# 是否是Firefox浏览器【brower】

# 是否是IE浏览器【brower】

# 是否是safari浏览器【brower】

# 是否是微信浏览器【brower】

# 是否是移动端微信浏览器【brower】

# 是否有window对象【brower】

# 是否移动端浏览器【brower】

# 获取浏览器类型【brower】

# 字符串加密处理【string】

# 是否是字符串【string】

# 根据对象及映射字段，得到一个拼接后的字符串【string】

# 校验内容格式【reg】

# 正则表达式合集【reg】

# base64加密【file】

# base64解密【file】

# 获取文件类型【根据文件名、或File对象的type字段】【file】

# 向localStorage中存入数据【storage】

# 移除localStorage中的值【storage】

# 获取localstorage中的存储的数据【storage】

# 修正字符串或数字的长度【public】