String

An immutable sequence of Unicode characters.

Static Methods

format_time

String.format_time(
    time: int,
    format: String,
    timezone: String = symbol_info.timezone
  ): String

Formats a timestamp (in milliseconds since epoch) into a String based on the provided format and timezone.

Parameters

Name	Type	Default	Description
time	int		The timestamp in milliseconds since epoch to format.
format	String		The format String for the conversion.
timezone	String	symbol_info.timezone	The timezone to use for formatting.

Returns: String

---

from

Converts a value to its String representation.

Parameters

Name	Type	Default	Description
value	int		The integer value to convert.
format	String		The format String for the conversion.

Returns: String

Converts a float to String with the given format.

Parameters

Name	Type	Default	Description
value	float		The float value to convert.
format	String		The format String for the conversion.

Returns: String

Converts an integer to String using a Format constant.

Parameters

Name	Type	Default	Description
value	int		The integer value to convert.
format	Format		The Format constant controlling formatting.

Returns: String

Converts a float to String using a Format constant.

Parameters

Name	Type	Default	Description
value	float		The float value to convert.
format	Format		The Format constant controlling formatting.

Returns: String

Converts any value to its String representation.

Parameters

Name	Type	Default	Description
value	T		The value to convert to String.

Returns: String

Methods

contains

String.contains(self: String, str: String): bool

Checks if the String contains the specified substring.

Parameters

Name	Type	Default	Description
self	String
str	String		The substring to search for.

Returns: bool

---

ends_with

String.ends_with(self: String, str: String): bool

Checks if the String ends with the specified suffix.

Parameters

Name	Type	Default	Description
self	String
str	String		The suffix to search for.

Returns: bool

---

format

String.format(self: String, values: any): String

Formats the String as a template, substituting {} placeholders with the provided values.

Parameters

Name	Type	Default	Description
self	String
values	any		Variable number of values to substitute into the template.

Returns: String

---

index_of

String.index_of(self: String, str: String): int

Returns the zero-based index of the first occurrence of a substring, or na if not found.

Parameters

Name	Type	Default	Description
self	String
str	String		The substring to search for.

Returns: int

---

length

String.length(self: String): int

Returns the length of the String.

Parameters

Name	Type	Default	Description
self	String

Returns: int

---

lower

String.lower(self: String): String

Converts all characters in the String to lowercase.

Parameters

Name	Type	Default	Description
self	String

Returns: String

---

match

String.match(self: String, regex: String): String

Returns the matched substring if the String matches a regex pattern, or an empty String otherwise.

Parameters

Name	Type	Default	Description
self	String
regex	String		The regular expression pattern to match.

Returns: String

---

pad_end

String.pad_end(self: String, len: int, fill: String = " "): String

Right-pads the String with fill until it reaches at least len characters.

Parameters

Name	Type	Default	Description
self	String
len	int		The minimum target length in characters.
fill	String	" "	The padding String. Defaults to " ".

Returns: String

---

pad_start

String.pad_start(self: String, len: int, fill: String = " "): String

Left-pads the String with fill until it reaches at least len characters.

Parameters

Name	Type	Default	Description
self	String
len	int		The minimum target length in characters.
fill	String	" "	The padding String. Defaults to " ".

Returns: String

---

repeat

String.repeat(self: String, repeat: int): String

Returns a new String consisting of the String repeated a specified number of times.

Parameters

Name	Type	Default	Description
self	String
repeat	int		The number of times to repeat the String.

Returns: String

---

replace

String.replace(
    self: String,
    target: String,
    replacement: String,
    occurrence: int = 0
  ): String

Replaces the N-th occurrence of a target substring with a replacement.

Parameters

Name	Type	Default	Description
self	String
target	String		The substring to be replaced.
replacement	String		The replacement substring.
occurrence	int	0	N-th occurrence to replace (0-indexed). Defaults to 0.

Returns: String

---

replace_all

String.replace_all(self: String, target: String, replacement: String): String

Replaces all occurrences of a target substring with a replacement.

Parameters

Name	Type	Default	Description
self	String
target	String		The substring to be replaced.
replacement	String		The replacement substring.

Returns: String

---

split

String.split(self: String, separator: String): Array<String>

Splits the String into an array of substrings based on a separator.

Parameters

Name	Type	Default	Description
self	String
separator	String		The separator String to split on.

Returns: Array<String>

---

starts_with

String.starts_with(self: String, str: String): bool

Checks if the String starts with the specified prefix.

Parameters

Name	Type	Default	Description
self	String
str	String		The prefix to search for.

Returns: bool

---

substring

String.substring(self: String, begin_pos: int, end_pos: int): String

Returns a substring from begin_pos to end_pos (exclusive).

Parameters

Name	Type	Default	Description
self	String
begin_pos	int		The starting position (inclusive).
end_pos	int		The ending position (exclusive).

Returns: String

---

to_number

String.to_number(self: String): float

Converts the String to a floating-point number.

Parameters

Name	Type	Default	Description
self	String

Returns: float — The parsed float value, or na if the String cannot be parsed.

---

trim

String.trim(self: String): String

Trims leading and trailing whitespace from the String.

Parameters

Name	Type	Default	Description
self	String

Returns: String

---

trim_end

String.trim_end(self: String): String

Trims trailing whitespace from the String.

Parameters

Name	Type	Default	Description
self	String

Returns: String

---

trim_start

String.trim_start(self: String): String

Trims leading whitespace from the String.

Parameters

Name	Type	Default	Description
self	String

Returns: String

---

upper

String.upper(self: String): String

Converts all characters in the String to uppercase.

Parameters

Name	Type	Default	Description
self	String

Returns: String