str

函数

contains

str.contains(source: string, str: string): bool

检查源字符串是否包含指定的子字符串。

参数

名称	类型	默认值	说明
source	string		要在其中搜索的字符串。
str	string		要搜索的子字符串。

返回: bool

---

endswith

str.endswith(source: string, str: string): bool

检查源字符串是否以指定的子字符串结尾。

参数

名称	类型	默认值	说明
source	string		要检查的字符串。
str	string		要搜索的后缀。

返回: bool

---

format

str.format(format: string, values: any): string

使用给定的格式和值格式化字符串。

参数

名称	类型	默认值	说明
format	string		格式字符串。
values	any		要格式化为字符串的可变数量的值。

返回: string

---

format_time

str.format_time(
    time: int,
    format: string,
    timezone: string = syminfo.timezone
  ): string

根据提供的格式和时区将时间戳（自纪元以来以毫秒为单位）格式化为字符串。 'M'、'd'、'h'、'H'、'm' 和 's' 标记都可以加倍以生成前导零。例如，一月将显示为带有“M”的 1，或带有“MM”的 01。最常用的格式化标记是： 'y' - 年份。使用“yy”输出年份的最后两位数字，或使用“yyyy”输出全部四位数字。 2000 年将是 00（带有“yy”）或 2000 年（带有“yyyy”）。 'M' - 月份。不要与小写“m”混淆，后者代表分钟。 'd' - 一个月中的某一天。 'a' - AM/PM 后缀。 'h' - 12 小时格式的小时。在此格式中，当天的最后一个小时将是“11”。 'H' - 24 小时格式的小时。在此格式中，当天的最后一个小时将是“23”。 'm' - 分钟。 's' - 第二。 'S' - 秒的几分之一。 'Z' - 时区，相对于 UTC 的时针偏移量，前面带有 '+' 或 '-'。

参数

名称	类型	默认值	说明
time	int		自格式化纪元以来的时间戳（以毫秒为单位）。
format	string		用于转换的格式字符串。
timezone	string	syminfo.timezone	用于格式化的时区。

返回: string

---

length

str.length(str: string): int

返回给定字符串的长度。

参数

名称	类型	默认值	说明
str	string		待确定长度的字符串。

返回: int

---

lower

str.lower(str: string): string

将字符串中的所有字符转换为小写。

参数

名称	类型	默认值	说明
str	string		要转换为小写的字符串。

返回: string

---

match

str.match(source: string, regex: string): string

如果源字符串与 regex 正则表达式匹配，则返回源字符串的新子字符串，否则返回空字符串。

参数

名称	类型	默认值	说明
source	string		要搜索的字符串。
regex	string		要匹配的正则表达式模式。

返回: string — 匹配的子字符串，如果未找到匹配则为空字符串。

---

pos

str.pos(source: string, str: string): int

返回子字符串在字符串中第一次出现的位置，如果未找到，则返回 na。

参数

名称	类型	默认值	说明
source	string		要在其中搜索的字符串。
str	string		要搜索的子字符串。

返回: int — 第一次出现的从零开始的索引，如果未找到，则为 na。

---

repeat

str.repeat(source: string, repeat: int): string

返回由重复指定次数的源字符串组成的新字符串。

参数

名称	类型	默认值	说明
source	string		要重复的字符串。
repeat	int		重复字符串的次数。

返回: string

---

replace

str.replace(
    source: string,
    target: string,
    replacement: string,
    occurrence: int = 0
  ): string

用替换子字符串替换源字符串中出现的目标子字符串。

参数

名称	类型	默认值	说明
source	string		要在其中执行替换的原始字符串。
target	string		要替换的子字符串。
replacement	string		用于替换目标的子字符串。
occurrence	int	0	要替换的目标字符串第 N 次出现。第一个匹配的索引从 0 开始。

返回: string

---

replace_all

str.replace_all(source: string, target: string, replacement: string): string

将源字符串中所有出现的目标子字符串替换为替换子字符串。

参数

名称	类型	默认值	说明
source	string		要在其中执行替换的原始字符串。
target	string		要替换的子字符串。
replacement	string		用于替换目标的子字符串。

返回: string

---

split

str.split(source: string, separator: string): Array<string>

根据指定的分隔符将源字符串拆分为子字符串数组。

参数

名称	类型	默认值	说明
source	string		要分割的字符串。
separator	string		要分割的分隔符字符串。

返回: Array<string>

---

startswith

str.startswith(source: string, str: string): bool

检查源字符串是否以指定的子字符串开头。

参数

名称	类型	默认值	说明
source	string		要检查的字符串。
str	string		要搜索的前缀。

返回: bool

---

substring

str.substring(source: string, begin_pos: int, end_pos: int): string

返回源字符串中从 begin_pos 到 end_pos（不包括）的子字符串。

参数

名称	类型	默认值	说明
source	string		要从中提取的字符串。
begin_pos	int		起始位置（含）。
end_pos	int		结束位置（独占）。

返回: string

---

tonumber

str.tonumber(str: string): float

将字符串转换为浮点数。

参数

名称	类型	默认值	说明
str	string		要转换为数字的字符串。

返回: float — 解析的浮点值，如果字符串无法解析为数字，则为 na。

---

tostring

将值转换为其字符串表示形式。

参数

名称	类型	默认值	说明
value	int		要转换的整数值。
format	string		用于转换的格式字符串。

返回: string

将浮点数转换为具有给定格式的字符串。

参数

名称	类型	默认值	说明
value	float		要转换的浮点值。
format	string		用于转换的格式字符串。

返回: string

将值转换为其字符串表示形式。

参数

名称	类型	默认值	说明
value	int		要转换为字符串的值。
format	Format		The Format constant controlling formatting.

返回: string

使用 Format 常量将浮点数转换为字符串。

参数

名称	类型	默认值	说明
value	float		The float value to convert.
format	Format		The Format constant controlling formatting.

返回: string

将值转换为其字符串表示形式。

参数

名称	类型	默认值	说明
value	T		The value to convert to string.

返回: string

---

trim

str.trim(str: string): string

修剪给定字符串的前导和尾随空格。

参数

名称	类型	默认值	说明
str	string		要修剪的字符串。

返回: string

---

upper

str.upper(str: string): string

将字符串中的所有字符转换为大写。

参数

名称	类型	默认值	说明
str	string		要转换为大写的字符串。

返回: string