StringUtils
const StringUtils: object
Defined in: string/index.ts:26
字符串工具函数
引入
import { StringUtils } from '@qy/lancet-ts-core'
函数列表
Type Declaration
capitalize()
capitalize(str): string
将字符串的首字母转换为大写，其余字符转换为小写
类型签名
function capitalize(str: string): string
Parameters
Returns
string
转换后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
const result = StringUtils.capitalize('hELLO')
console.log(result) // Output: 'Hello'
isBlank()
isBlank(str): boolean
检查字符串是否为空或仅包含空白字符
类型签名
function isBlank(str: string): boolean
Parameters
Returns
boolean
如果字符串为空或仅包含空白字符则返回 true，否则返回 false
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.isBlank('')) // Output: true
console.log(StringUtils.isBlank(' ')) // Output: true
console.log(StringUtils.isBlank('abc')) // Output: false
isString()
isString(value): value is string
检查值是否为字符串原始值或对象
类型签名
function isString(value: unknown): value is string
Parameters
Returns
value is string
如果值是字符串则返回 true，否则返回 false
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.isString('abc')) // Output: true
console.log(StringUtils.isString(123)) // Output: false
lowerFirst()
lowerFirst(str): string
将字符串的首字母转换为小写
类型签名
function lowerFirst(str: string): string
Parameters
Returns
string
转换后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
const result = StringUtils.lowerFirst('Hello')
console.log(result) // Output: 'hello'
pad()
pad(str, length, chars?): string
如果字符串长度小于指定长度，则在左右两侧填充字符。如果填充字符无法均匀分配，则会被截断。
类型签名
function pad(str: string, length: number, chars?: string): string
Parameters
Returns
string
填充后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.pad('abc', 8)) // Output: ' abc '
console.log(StringUtils.pad('abc', 8, '_-')) // Output: '_-abc_-_'
padEnd()
padEnd(str, length, chars?): string
如果字符串长度小于指定长度，则在右侧填充字符。如果填充字符超过长度，则会被截断。
类型签名
function padEnd(str: string, length: number, chars?: string): string
Parameters
Returns
string
填充后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.padEnd('abc', 6)) // Output: 'abc '
console.log(StringUtils.padEnd('abc', 6, '_-')) // Output: 'abc_-_'
padStart()
padStart(str, length, chars?): string
如果字符串长度小于指定长度，则在左侧填充字符。如果填充字符超过长度，则会被截断。
类型签名
function padStart(str: string, length: number, chars?: string): string
Parameters
Returns
string
填充后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.padStart('abc', 6)) // Output: ' abc'
console.log(StringUtils.padStart('abc', 6, '_-')) // Output: '_-_abc'
reverse()
reverse(str): string
反转字符串
类型签名
function reverse(str: string): string
Parameters
Returns
string
反转后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
const result = StringUtils.reverse('hello')
console.log(result) // Output: 'olleh'
substr()
substr(str, start, length?): string
根据起始位置和长度提取字符串的片段
类型签名
function substr(str: string, start: number, length?: number): string
Parameters
Returns
string
提取后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.substr('hello world', 6)) // Output: 'world'
console.log(StringUtils.substr('hello world', 0, 5)) // Output: 'hello'
truncate()
truncate(str, length, omission?): string
如果字符串长度超过给定的最大长度，则截断字符串。
截断后的字符串末尾替换为省略号（默认为 "..."）。
类型签名
function truncate(str: string, length: number, omission?: string): string
Parameters
Returns
string
截断后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
console.log(StringUtils.truncate('hello world', 5)) // Output: 'he...'
console.log(StringUtils.truncate('hello world', 8, '...')) // Output: 'hello...'
upperFirst()
upperFirst(str): string
将字符串的首字母转换为大写
类型签名
function upperFirst(str: string): string
Parameters
Returns
string
转换后的字符串
Example
import { StringUtils } from '@qy/lancet-ts-core'
const result = StringUtils.upperFirst('hello')
console.log(result) // Output: 'Hello'
