Variable stringUtils`Const`

stringUtils: {
    accAdd(arg1, arg2): string;
    accDiv(arg1, arg2, retainNum?): string;
    accMul(arg1, arg2): number;
    accSub(arg1, arg2): string;
    camelToKebab(str, separator?): string;
    compareVersion(v1, v2): number;
    firstLetterToUpper(str): string;
    fromUrlParams(str, option?): {
        [key: string]: unknown;
    };
    hideChar(str, start?, end?, replaceStr?): string;
    hua5Split(str, separator?): any[];
    isNumeric(str): boolean;
    kebabToCamel(str, separator?): string;
    moneyUnit(val, unit?): string;
    reverse(str): string;
    to100Num(rate): number;
    to100Rate(str, fiexd?): string | number;
    toFixed(str, fixed?): string;
    trim(str, pos?): string;
    trimAll(str): string;
    trimChar(str, char, pos?): string;
    trimLeft(str): string;
    trimRight(str): string;
} = ...

string 相关工具方法

Type declaration

accAdd:function
- accAdd(arg1, arg2): string
- 加法运算
  Parameters
  - arg1: string | number
    被加数
  - arg2: string | number
    加数
  Returns string
  加法运算的结果
  Example
```
stringUtils.accAdd('1', '2') // '3.00'
stringUtils.accAdd('1.000000', '2.000000') // '3.000000'
stringUtils.accAdd('1.001', '2.01') // '3.011'
```
  - Defined in src/string.ts:277
accDiv:function
- accDiv(arg1, arg2, retainNum?): string
- 除法运算
  Parameters
  - arg1: string | number
    被除数
  - arg2: string | number
    除数
  - retainNum: number = 3
    保留小数点后的位数, 默认3
  Returns string
  商
  Example
```
stringUtils.accDiv('1', '2') // '0.500'
stringUtils.accDiv('1.001', '2.01') // '0.498'
```
  - Defined in src/string.ts:324
accMul:function
- accMul(arg1, arg2): number
- 乘法运算
  Parameters
  - arg1: string | number
    被乘数
  - arg2: string | number
    乘数
  Returns number
  乘积结果
  Example
```
stringUtils.accMul('1', '2') // 2
stringUtils.accMul('1.001', '2.01') // 2.01201
```
  - Defined in src/string.ts:308
accSub:function
- accSub(arg1, arg2): string
- 减法运算
  Parameters
  - arg1: string | number
    被减数
  - arg2: string | number
    减数
  Returns string
  减法运算结果
  Example
```
stringUtils.accSub('1', '2') // '-1.00'
stringUtils.accSub('1.000000', '2.000000') // '-1.000000'
stringUtils.accSub('1.001', '2.01') // '-1.009'
```
  - Defined in src/string.ts:293
camelToKebab:function
- camelToKebab(str, separator?): string
- 将驼峰命名转换为连字符 - 命名
  Parameters
  - str: string
    驼峰命名的字符串
  - separator: string = '-'
    连字符的分隔符，默认为 '-'
  Returns string
  连字符命名的字符串
  Example
```
stringUtils.camelToKebab('camelToKebab') // 'camel-to-kebab
stringUtils.camelToKebab('CamelToKebab', '_') // 'camel_to_kebab'
```
  - Defined in src/string.ts:375
compareVersion:function
- compareVersion(v1, v2): number
- 比较版本号大小
  Parameters
  - v1: string
    版本号1
  - v2: string
    版本号2
  Returns number
  如果 v1 > v2，返回 1；如果 v1 < v2，返回 -1；如果 v1 = v2，返回 0。
  Example
```
stringUtils.compareVersion("1.0.1", "1.1.1") // -1
stringUtils.compareVersion("1.1.1", "1.0.1") // 1
stringUtils.compareVersion("1.1.1", "1.1.1") // 0
```
  - Defined in src/string.ts:340
firstLetterToUpper:function
- firstLetterToUpper(str): string
- 首字母大写
  Parameters
  - str: string
    字符串
  Returns string
  首字母大写后的字符串
  Example
```
stringUtils.firstLetterToUpper(asa) // 'Asa'
stringUtils.firstLetterToUpper("哈哈哈") // '哈哈哈'
stringUtils.firstLetterToUpper("hhhh") // 'Hhhh'
```
  - Defined in src/string.ts:199

fromUrlParams:function

fromUrlParams(str, option?): {
[key: string]: unknown;
}

将url参数字符串转换为对象

Parameters

str: string
url参数字符串
option: IParseOptions<undefined> = {}
qs.parse的配置项

Returns {
[key: string]: unknown;
}

转换后的url参数对象

[key: string]: unknown

Example

stringUtils.fromUrlParams("?a=1&b[c]=3&b[d]=4") // { a: '1', b: { c: '3', d: '4' }}
stringUtils.fromUrlParams("?a=1^b[c]=3^b[d]=4",{ delimiter: '^' }) // { a: '1', b: { c: '3', d: '4' }}
stringUtils.fromUrlParams("a&b=", { strictNullHandling: true }) // { a: null, b: '' }
stringUtils.fromUrlParams("a&b=") // { a: '', b: '' }

hideChar:function
- hideChar(str, start?, end?, replaceStr?): string
- 将字符串指定位置的字符替换为指定字符
  Parameters
  - str: string
    字符串
  - start: number = 4
    在字符串开始处保留的字符数量, 默认4
  - end: number = 4
    在字符串结束处保留的字符数量, 默认4
  - replaceStr: string = '*'
    替换的字符串, 默认为*
  Returns string
  替换后的字符串
  Example
```
stringUtils.hideChar("12345678910") // '1234***8910'
stringUtils.hideChar("12345678910",3,4) // '123****8910'
stringUtils.hideChar("12345678910", 5, 4, '^') // '12345^^8910'
```
  - Defined in src/string.ts:38
hua5Split:function
- hua5Split(str, separator?): any[]
- 字符串转数组扩展这个方法的原因，原生split的分割(''.split(',') => [''])，无法得到一个[]
  Parameters
  - str: string
    被分割的字符串
  - separator: string = ','
    分隔符，默认值 ','
  Returns any[]
  分割后的数组
  Example
```
stringUtils.hua5Split('') // []
stringUtils.hua5Split('123') // ['123']
stringUtils.hua5Split('123,456,789,,123,') // ['123', '456', '789', '', '123', '']
```
  - Defined in src/string.ts:445
isNumeric:function
- isNumeric(str): boolean
- 是否为数值型字符串
  Parameters
  - str: string
    字符串
  Returns boolean
  Example
```
stringUtils.isNumeric("123") // true
stringUtils.isNumeric("3213a") // false
stringUtils.isNumeric("123.11") // true
```
  - Defined in src/string.ts:235
kebabToCamel:function
- kebabToCamel(str, separator?): string
- 将连字符命名转换为驼峰命名
  Parameters
  - str: string
    连字符命名的字符串
  - separator: string = '-'
    连字符的分隔符，默认为 '-'
  Returns string
  驼峰命名的字符串
  Example
```
stringUtils.kebabToCamel('kebab-case-string') // 'kebabCaseString
stringUtils.kebabToCamel('kebab_case_string', '_') // 'kebabCaseString'
```
  - Defined in src/string.ts:392

moneyUnit:function

moneyUnit(val, unit?): string

金额添加 + 或 - 号

Parameters

val: string | number
金额
unit: string = '+'
单位, 只能是 + 或 -, 默认 +

Returns string

带符号的金额

Example

stringUtils.moneyUnit("12") // '+12'
stringUtils.moneyUnit("12", '-') // '-12'
stringUtils.moneyUnit("12", ' ') // ''
stringUtils.moneyUnit("-12") // '-12'
stringUtils.moneyUnit("+12") // '+12'
stringUtils.moneyUnit(-12,'+') // '-12'
stringUtils.moneyUnit(+12,' ') // ''
stringUtils.moneyUnit(12,'-') // '-12'

reverse:function
- reverse(str): string
- 翻转字符串
  Parameters
  - str: string
    字符串
  Returns string
  翻转的结果
  Example
```
stringUtils.reverse("12") // '21'
stringUtils.reverse("测试") // '试测'
```
  - Defined in src/string.ts:18
to100Num:function
- to100Num(rate): number
- 字符串百分比转换为数值
  Parameters
  - rate: string | number
    要转换为数字的百分比值。
  Returns number
  返回转换后的数字值，如果输入无效或小于等于 0，则返回 0。
  Example
```
stringUtils.to100Num(20) //2000
stringUtils.to100Num(0.2) // 20
```
  - Defined in src/string.ts:428
to100Rate:function
- to100Rate(str, fiexd?): string | number
- 数值型字符串转换为百分比
  Parameters
  - str: string | number
    要转换为百分比的数值型字符串。
  - fiexd: number = 4
    保留的小数位数，默认为 4。
  Returns string | number
  返回转换后的百分比值，如果输入无效或小于等于 0，则返回 0。
  Example
```
stringUtils.to100Rate(20) // '0.2000'
stringUtils.to100Rate(0.2) // '0.0020'
```
  - Defined in src/string.ts:414
toFixed:function
- toFixed(str, fixed?): string
- 将数值型字符串转换为固定小数位数的数值型字符串, 无法转换默认输出 '0.00'
  Parameters
  - str: string
    需要转换的输入字符串
  - fixed: number = 2
    结果数字的小数位数，默认为2
  Returns string
  - 返回固定小数位数的数值型字符串
  Example
```
stringUtils.toFixed("123") // '123.00'
stringUtils.toFixed("123.120,3") // '123.120'
stringUtils.toFixed("123.1205",3) // '123.121'
stringUtils.toFixed("123ad") // '0.00'
```
  - Defined in src/string.ts:256
trim:function
- trim(str, pos?): string
- 去除字符串指定位置的空格
  Parameters
  - str: string
    字符串
  - pos: string = 'both'
    去除位置, both:去除前后空格(默认), all:去除所有空格, left:去除左边空格, right:去除右边空格,
  Returns string
  去除空格后的字符串
  Example
```
stringUtils.trim("  asad ") // 'asad'
stringUtils.trim("  asad ", ' ') // '  asad '
stringUtils.trim("  asad ", left) // 'asad '
stringUtils.trim("  asad ",right) // '  asad'
stringUtils.trim("  asad ",both) // 'asad'
stringUtils.trim('  a s ad ','all') // 'asad'
```
  - Defined in src/string.ts:101
trimAll:function
- trimAll(str): string
- 去除字符中的所有空格
  Parameters
  - str: string
    字符串
  Returns string
  去除空格后的字符串
  Example
```
stringUtils.trimAll("  asad ") // 'asad'
stringUtils.trimAll(" as ad  ") // 'asad'
```
  - Defined in src/string.ts:153
trimChar:function
- trimChar(str, char, pos?): string
- 去除字符中的指定字符
  Parameters
  - str: string
    字符串
  - char: string
    要去除的字符
  - pos: string = "both"
    去除位置, both:去除前后空格(默认), all:去除所有空格, left:去除左边空格, right:去除右边空格,
  Returns string
  去除空格后的字符串
  Example
```
stringUtils.trimChar("-asad-",'-') // 'asad'
stringUtils.trimChar(-asad-", '-', 'left') // 'asad-'
stringUtils.trimChar("-asad-", '-', 'right') // '-asad'
stringUtils.trimChar("-asad-", '-', 'both') // 'asad'
stringUtils.trimChar("-a-sad-", '-', 'all') // 'asad'
stringUtils.trimChar(" a sad ", ' ', 'all') // 'asad'
```
  - Defined in src/string.ts:173
trimLeft:function
- trimLeft(str): string
- 去除字符左边空格
  Parameters
  - str: string
    字符串
  Returns string
  去除空格后的字符串
  Example
```
stringUtils.trimLeft("  asad ") // 'asad '
stringUtils.trimLeft("  asad ") // 'asad '
```
  - Defined in src/string.ts:125
trimRight:function
- trimRight(str): string
- 去除字符右边空格
  Parameters
  - str: string
    字符串
  Returns string
  去除空格后的字符串
  Example
```
stringUtils.trimRight("  asad ") // '  asad'
stringUtils.trimRight("asad  ") // 'asad'
```
  - Defined in src/string.ts:139

Variable stringUtilsConst

Type declaration

accAdd:function

Parameters

Returns string

Example

accDiv:function

Parameters

Returns string

Example

accMul:function

Parameters

Returns number

Example

accSub:function

Parameters

Returns string

Example

camelToKebab:function

Parameters

Returns string

Example

compareVersion:function

Parameters

Returns number

Example

firstLetterToUpper:function

Parameters

Returns string

Example

fromUrlParams:function

Parameters

Returns { [key: string]: unknown; }

[key: string]: unknown

Example

hideChar:function

Parameters

Returns string

Example

hua5Split:function

Parameters

Returns any[]

Example

isNumeric:function

Parameters

Returns boolean

Example

kebabToCamel:function

Parameters

Returns string

Example

moneyUnit:function

Parameters

Returns string

Example

reverse:function

Parameters

Returns string

Example

to100Num:function

Parameters

Returns number

Example

to100Rate:function

Parameters

Returns string | number

Example

toFixed:function

Parameters

Returns string

Example

trim:function

Parameters

Returns string

Example

trimAll:function

Parameters

Returns string

Example

trimChar:function

Variable stringUtils`Const`

Returns {
[key: string]: unknown;
}