API String

String

文本转换与处理

Text conversion and processing

脚本 API 目录

Script API Directory

概述

Overview

AuroraScript 字符串是不可变值。所有实例方法都返回新文本或结果，不会修改原字符串。索引按 .NET UTF-16 code unit 计数。

AuroraScript strings are immutable values. Instance methods return new text or a result and never mutate the original string. Indexes count .NET UTF-16 code units.

String([value]) / String.valueOf(value)

Parameters:

• value
  可选待转换值。

  Optional value to convert.

Returns

字符串；缺失或不能转换时为空字符串。

A string; missing or non-convertible input becomes an empty string.

var left = String(42);
var right = String.valueOf(true);
return left + ":" + right; // 42:true

String.fromCharCode(charCode)

Parameters:

• charCode
  字符编码。

  Character code.

Returns

单字符字符串。

One-character string.

return String.fromCharCode(65); // A

String.compare(left, right)

Parameters:

• left、right
  要比较的字符串。

  Strings to compare.

Returns

小于、等于或大于零的排序结果。

Ordering result below, equal to, or above zero.

return String.compare("a", "b") < 0; // true

text.length

Returns

字符串长度。

String length.

return "Aurora".length; // 6

text.contains(value)

Parameters:

• value
  子串。

  Substring.

Returns

是否包含该子串。

Whether the substring occurs.

return "AuroraScript".contains("Script"); // true

text.indexOf(value) / text.lastIndexOf(value)

Parameters:

• value
  子串。

  Substring.

Returns

首次或最后一次匹配索引；未找到时为 -1。

First or last match index; -1 when missing.

var text = "a-b-a";
var first = text.indexOf("a");
return text.lastIndexOf("a") - first; // 4

text.startsWith(value) / text.endsWith(value)

Parameters:

• value
  前缀或后缀。

  Prefix or suffix.

Returns

是否匹配。

Whether it matches.

var text = "AuroraScript";
return text.startsWith("Aurora") && text.endsWith("Script");

text.substring(start, [end])

Parameters:

• start
  起始索引。

  Starting index.

• end
  可选结束索引。

  Optional end index.

Returns

子字符串。

Substring.

边界行为

索引会被限制到有效范围；start > end 时运行时会交换它们。

Indexes are clamped to valid bounds; the runtime swaps start and end when start > end.

return "Aurora".substring(0, 3); // Aur

text.slice(start, [end])

Parameters:

• start
  起始索引。

  Starting index.

• end
  可选结束索引。

  Optional end index.

Returns

字符串切片。

String slice.

return "Aurora".slice(3); // ora

text.split([separator])

Parameters:

• separator
  可选分隔字符串。

  Optional separator string.

Returns

字符串数组；省略分隔符时返回只含原文本的数组。

Array of strings; omitting it returns an array containing the original text.

return "a,b,c".split(",").length; // 3

text.match(pattern)

Parameters:

• pattern
Regex 或模式字符串。

  Regex or pattern string.

Returns

匹配结果；没有匹配时为 null。

Match result, or null when there is no match.

return "v42".match(new Regex("[0-9]+"));

text.matchAll(pattern)

Parameters:

• pattern
  带全局 g 标志的 Regex 或模式。

  Regex with global g flag or a pattern.

Returns

全部匹配构成的数组。

Array of all matches.

边界行为

全量匹配需要全局 Regex。

Full matching requires a global regex.

return "a1b2".matchAll(new Regex("[0-9]", "g")).length; // 2

text.replace(pattern, replacement)

Parameters:

• pattern
  字符串或 Regex。

  String or Regex.

• replacement
  替换字符串或回调。

  Replacement string or callback.

Returns

新字符串。

New string.

边界行为

全局 Regex 会替换所有匹配；普通字符串替换该文本的匹配。

A global regex replaces all matches; a string replacement uses the text match behavior.

return "a-b".replace("-", ":"); // a:b

text.padLeft(width, padding) / text.padRight(width, padding)

Parameters:

• width
  目标长度。

  Target length.

• padding
  用作填充的字符串，其首字符用于填充。

  Padding string; its first character is used.

Returns

填充后的新字符串。

Padded new string.

var left = "7".padLeft(3, "0");
return left.padRight(4, "_"); // 007_

text.trim() / text.trimLeft() / text.trimRight()

Parameters:

• 无。

  None.

Returns

去除两端、左端或右端空白后的新字符串。

New string with both, left, or right whitespace removed.

var text = "  Aurora  ";
return text.trimLeft().trimRight().trim(); // Aurora

text.charCodeAt(index)

Parameters:

• index
  字符索引。

  Character index.

Returns

UTF-16 code unit；越界时为 NaN。

UTF-16 code unit, or NaN when out of range.

return "A".charCodeAt(0); // 65

text.toLowerCase() / text.toUpperCase()

Parameters:

• 无。

  None.

Returns

大小写转换后的新字符串。

New lower- or upper-case string.

var name = "Aurora";
return name.toLowerCase() + ":" + name.toUpperCase();

text.toString()

Parameters:

• 无。

  None.

Returns

原字符串。

The same string value.

return "Aurora".toString();