@bizjs/biz-utils

Type aliases

DownloadBlobOptions

DownloadBlobOptions: { filename?: string; query?: UrlQuery; xhrOptions?: { headers?: Record<string, string>; withCredenticals?: boolean }; onProgress?: any }

Type declaration

Optional filename?: string
Optional query?: UrlQuery
Optional xhrOptions?: { headers?: Record<string, string>; withCredenticals?: boolean }
- Optional headers?: Record<string, string>
- Optional withCredenticals?: boolean
onProgress?:function
- onProgress(total: number, loaded: number, e?: ProgressEvent<EventTarget>): void
- - Defined in packages/biz-utils/src/browserUtils.ts:47
  Parameters
  - total: number
  - loaded: number
  - Optional e: ProgressEvent<EventTarget>
  Returns void

DownloadOptions

DownloadOptions: OpenUrlOptions & { filename?: string }

OpenUrlOptions

OpenUrlOptions: { newWindow?: boolean; query?: UrlQuery }

Type declaration

Optional newWindow?: boolean
Optional query?: UrlQuery

Functions

copyText

copyText(content: string): Promise<void>

- Defined in packages/biz-utils/src/browserUtils.ts:100
Parameters
- content: string
Returns Promise<void>

distinct

distinct<T>(arr: T[], keyFn?: (x: T) => any): T[]

- Defined in packages/biz-utils/src/moreUtils.ts:55
数组去重

Type parameters
- T = any
Parameters
- arr: T[]
- keyFn: (x: T) => any = ...
  - - (x: T): any
    - Parameters
      - x: T
      Returns any
Returns T[]

download

download(url: string, options?: DownloadOptions): void

- Defined in packages/biz-utils/src/browserUtils.ts:38
文件下载（常规模式，浏览器打开下载链接）

Parameters
- url: string
- Optional options: DownloadOptions
Returns void

downloadBlob

downloadBlob(url: string, options?: DownloadBlobOptions): Promise<boolean>

- Defined in packages/biz-utils/src/browserUtils.ts:59
下载文件（二进制模式，支持进度条）

Parameters
- url: string
- Optional options: DownloadBlobOptions
Returns Promise<boolean>

formatDate

formatDate(date: DateLike, formatTemplate: "datetime" | "date" | "time"): string
formatDate(date: DateLike, formatTemplate: string): string

- Defined in packages/biz-utils/src/dateUtils.ts:19
格式化日期

Parameters
- date: DateLike
- formatTemplate: "datetime" | "date" | "time"
Returns string
- Defined in packages/biz-utils/src/dateUtils.ts:20
Parameters
- date: DateLike
- formatTemplate: string
Returns string

generateUniqueId

generateUniqueId(len?: number): string

- Defined in packages/biz-utils/src/moreUtils.ts:18
生成一个唯一字符串，默认 12 位长度

Parameters
- len: number = 12
  
  可动态指定长度，8~32 位，默认 12 位
Returns string

generateUuid

generateUuid(): string

- Defined in packages/biz-utils/src/moreUtils.ts:9
生成 UUID

Returns string

getExtName

getExtName(filepath: string, options?: { toLower?: boolean }): string

- Defined in packages/biz-utils/src/moreUtils.ts:76
获取扩展名

Parameters
- filepath: string
- Optional options: { toLower?: boolean }
  - Optional toLower?: boolean
Returns string

getQuery

getQuery(search?: string): Record<string, string | undefined>

- Defined in packages/biz-utils/src/browserUtils.ts:12
将浏览器的 querystring 转换为对象

Parameters
- Optional search: string
Returns Record<string, string | undefined>

getTDate

getTDate(tNum: number, date?: DateLike): Date

- Defined in packages/biz-utils/src/dateUtils.ts:35
获取 T+N 日期，

Parameters
- tNum: number
- Optional date: DateLike
  
  开始日期，如果不传则默认为当前日期
Returns Date

isChineseLandlineNumber

isChineseLandlineNumber(landlineNumber: string): boolean

- Defined in packages/biz-utils/src/formRules.ts:23
是否是中国座机号码座机号规则：区号（可选，一个 0 加上 2~~3 位数字）+ 固定电话（7~~8 位数字）+分机号（可选）详细规则见：

Parameters
- landlineNumber: string
Returns boolean

isChinesePhoneNumber

isChinesePhoneNumber(phoneNumber: string): boolean

- Defined in packages/biz-utils/src/formRules.ts:13
是否是中国手机号码

Parameters
- phoneNumber: string
Returns boolean

isEmail

isEmail(email: string, options?: IsEmailOptions): boolean

- Defined in packages/biz-utils/src/formRules.ts:34
是否是邮箱地址

Parameters
- email: string
- Optional options: IsEmailOptions
Returns boolean

isIdCardNo

isIdCardNo(idCard: string): boolean

- Defined in packages/biz-utils/src/formRules.ts:43
是否是中国身份证号代码来自：validator/es/lib/isIdentityCard/zh-CN

Parameters
- idCard: string
Returns boolean

isIpV4

isIpV4(ip: string): boolean

- Defined in packages/biz-utils/src/formRules.ts:159
Parameters
- ip: string
Returns boolean

isIpV6

isIpV6(ip: string): boolean

- Defined in packages/biz-utils/src/formRules.ts:155
Parameters
- ip: string
Returns boolean

isURL

isURL(url: string, options?: IsURLOptions): boolean

- Defined in packages/biz-utils/src/formRules.ts:165
Parameters
- url: string
- Optional options: IsURLOptions
Returns boolean

numberAdd

numberAdd(num1: string | number, ...nums: (string | number)[]): string

- Defined in packages/biz-utils/src/numeralUtils.ts:10
精确的数值加法

Parameters
- num1: string | number
- Rest ...nums: (string | number)[]
Returns string

numberDiv

numberDiv(num1: string | number, ...nums: (string | number)[]): string

- Defined in packages/biz-utils/src/numeralUtils.ts:52
精确的数值除法

Parameters
- num1: string | number
- Rest ...nums: (string | number)[]
Returns string

numberMul

numberMul(num1: string | number, ...nums: (string | number)[]): string

- Defined in packages/biz-utils/src/numeralUtils.ts:38
精确的数值乘法

Parameters
- num1: string | number
- Rest ...nums: (string | number)[]
Returns string

numberSub

numberSub(num1: string | number, ...nums: (string | number)[]): string

- Defined in packages/biz-utils/src/numeralUtils.ts:24
精确的数值减法

Parameters
- num1: string | number
- Rest ...nums: (string | number)[]
Returns string

openUrl

openUrl(url: string, options?: OpenUrlOptions): void

- Defined in packages/biz-utils/src/browserUtils.ts:25
打开链接

Parameters
- url: string
- Optional options: OpenUrlOptions
Returns void

safeJSONParse

safeJSONParse<T>(jsonString: string, options?: { fallbackValue?: T }): null | T

- Defined in packages/biz-utils/src/moreUtils.ts:33
安全的转换 JSON String

Type parameters
- T: unknown = any
Parameters
- jsonString: string
- Optional options: { fallbackValue?: T }
  - Optional fallbackValue?: T
Returns null | T

Index

Interfaces

Type aliases

Functions

Type aliases

DownloadBlobOptions

Type declaration

Optional filename?: string

Optional query?: UrlQuery

Optional xhrOptions?: { headers?: Record<string, string>; withCredenticals?: boolean }

Optional headers?: Record<string, string>

Optional withCredenticals?: boolean

onProgress?:function

Parameters

total: number

loaded: number

Optional e: ProgressEvent<EventTarget>

Returns void

DownloadOptions

OpenUrlOptions

Type declaration

Optional newWindow?: boolean

Optional query?: UrlQuery

Functions

copyText

Parameters

content: string

Returns Promise<void>

distinct

Type parameters

T = any

Parameters

arr: T[]

keyFn: (x: T) => any = ...

Parameters

x: T

Returns any

Returns T[]

download

Parameters

url: string

Optional options: DownloadOptions

Returns void

downloadBlob

Parameters

url: string

Optional options: DownloadBlobOptions

Returns Promise<boolean>

formatDate

Parameters

date: DateLike

formatTemplate: "datetime" | "date" | "time"

Returns string

Parameters

date: DateLike

formatTemplate: string

Returns string

generateUniqueId

Parameters

len: number = 12

Returns string

generateUuid

Returns string

getExtName

Parameters

filepath: string

Optional options: { toLower?: boolean }

Optional toLower?: boolean

Returns string

getQuery

Parameters

Optional search: string

Returns Record<string, string | undefined>

getTDate

Parameters

tNum: number

Optional date: DateLike

Returns Date

isChineseLandlineNumber

Parameters