{"route":"/en-US-v0.13.1/reference/foundations/str/","title":"String","description":"Documentation for the String type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"escapes","name":"Escapes","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-value","name":"value","children":[]},{"id":"constructor-base","name":"base","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-len","name":"Length","children":[]},{"id":"definitions-first","name":"First","children":[]},{"id":"definitions-last","name":"Last","children":[]},{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-index","name":"index","children":[]},{"id":"definitions-at-default","name":"default","children":[]}]},{"id":"definitions-slice","name":"Slice","children":[{"id":"definitions-slice-start","name":"start","children":[]},{"id":"definitions-slice-end","name":"end","children":[]},{"id":"definitions-slice-count","name":"count","children":[]}]},{"id":"definitions-clusters","name":"Clusters","children":[]},{"id":"definitions-codepoints","name":"Codepoints","children":[]},{"id":"definitions-to-unicode","name":"To Unicode","children":[{"id":"definitions-to-unicode-character","name":"character","children":[]}]},{"id":"definitions-from-unicode","name":"From Unicode","children":[{"id":"definitions-from-unicode-value","name":"value","children":[]}]},{"id":"definitions-contains","name":"Contains","children":[{"id":"definitions-contains-pattern","name":"pattern","children":[]}]},{"id":"definitions-starts-with","name":"Starts With","children":[{"id":"definitions-starts-with-pattern","name":"pattern","children":[]}]},{"id":"definitions-ends-with","name":"Ends With","children":[{"id":"definitions-ends-with-pattern","name":"pattern","children":[]}]},{"id":"definitions-find","name":"Find","children":[{"id":"definitions-find-pattern","name":"pattern","children":[]}]},{"id":"definitions-position","name":"Position","children":[{"id":"definitions-position-pattern","name":"pattern","children":[]}]},{"id":"definitions-match","name":"Match","children":[{"id":"definitions-match-pattern","name":"pattern","children":[]}]},{"id":"definitions-matches","name":"Matches","children":[{"id":"definitions-matches-pattern","name":"pattern","children":[]}]},{"id":"definitions-replace","name":"Replace","children":[{"id":"definitions-replace-pattern","name":"pattern","children":[]},{"id":"definitions-replace-replacement","name":"replacement","children":[]},{"id":"definitions-replace-count","name":"count","children":[]}]},{"id":"definitions-trim","name":"Trim","children":[{"id":"definitions-trim-pattern","name":"pattern","children":[]},{"id":"definitions-trim-at","name":"at","children":[]},{"id":"definitions-trim-repeat","name":"repeat","children":[]}]},{"id":"definitions-split","name":"Split","children":[{"id":"definitions-split-pattern","name":"pattern","children":[]}]},{"id":"definitions-rev","name":"Reverse","children":[]}]}],"body":{"kind":"type","content":{"name":"str","title":"String","keywords":[],"oneliner":"A sequence of Unicode codepoints.","details":"

A sequence of Unicode codepoints.

\n

You can iterate over the grapheme clusters of the string using a for\nloop. Grapheme clusters are basically characters but\nkeep together things that belong together, e.g. multiple codepoints that\ntogether form a flag emoji. Strings can be added with the + operator,\njoined together and multiplied with integers.

\n

Typst provides utility methods for string manipulation. Many of these\nmethods (e.g., split, trim and replace) operate on patterns: A\npattern can be either a string or a regular expression. This makes\nthe methods quite versatile.

\n

All lengths and indices are expressed in terms of UTF-8 bytes. Indices are\nzero-based and negative indices wrap around to the end of the string.

\n

You can convert a value to a string with this type's constructor.

\n

Example

\n
#"hello world!" \\\n#"\\"hello\\n  world\\"!" \\\n#"1 2 3".split() \\\n#"1,2;3".split(regex("[,;]")) \\\n#(regex("\\d+") in "ten euros") \\\n#(regex("\\d+") in "10 euros")\n
\"Preview\"
\n

Escape sequences

\n

Just like in markup, you can escape a few symbols in strings:

\n","constructor":{"path":[],"name":"str","title":"Construct","keywords":[],"oneliner":"Converts a value to a string.","element":false,"contextual":false,"deprecation":null,"details":"

Converts a value to a string.

\n\n

If you wish to convert from and to Unicode code points, see the\nto-unicode and from-unicode\nfunctions.

","example":"
#str(10) \\\n#str(4000, base: 16) \\\n#str(2.7) \\\n#str(1e8) \\\n#str(<intro>)\n
\"Preview\"
","self":false,"params":[{"name":"value","details":"

The value that should be converted to a string.

","example":null,"types":["int","float","str","bytes","label","decimal","version","type"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"base","details":"

The base (radix) to display integers in, between 2 and 36.

","example":null,"types":["int"],"strings":[],"default":"10","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]},"scope":[{"path":["str"],"name":"len","title":"Length","keywords":[],"oneliner":"The length of the string in UTF-8 encoded bytes.","element":false,"contextual":false,"deprecation":null,"details":"

The length of the string in UTF-8 encoded bytes.

","example":null,"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["str"],"name":"first","title":"First","keywords":[],"oneliner":"Extracts the first grapheme cluster of the string.","element":false,"contextual":false,"deprecation":null,"details":"

Extracts the first grapheme cluster of the string.\nFails with an error if the string is empty.

","example":null,"self":true,"params":[],"returns":["str"],"scope":[]},{"path":["str"],"name":"last","title":"Last","keywords":[],"oneliner":"Extracts the last grapheme cluster of the string.","element":false,"contextual":false,"deprecation":null,"details":"

Extracts the last grapheme cluster of the string.\nFails with an error if the string is empty.

","example":null,"self":true,"params":[],"returns":["str"],"scope":[]},{"path":["str"],"name":"at","title":"At","keywords":[],"oneliner":"Extracts the first grapheme cluster after the specified index. Returns","element":false,"contextual":false,"deprecation":null,"details":"

Extracts the first grapheme cluster after the specified index. Returns\nthe default value if the index is out of bounds or fails with an error\nif no default value was specified.

","example":null,"self":true,"params":[{"name":"index","details":"

The byte index. If negative, indexes from the back.

","example":null,"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"default","details":"

A default value to return if the index is out of bounds.

","example":null,"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["str"],"name":"slice","title":"Slice","keywords":[],"oneliner":"Extracts a substring of the string.","element":false,"contextual":false,"deprecation":null,"details":"

Extracts a substring of the string.\nFails with an error if the start or end index is out of bounds.

","example":null,"self":true,"params":[{"name":"start","details":"

The start byte index (inclusive). If negative, indexes from the\nback.

","example":null,"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"end","details":"

The end byte index (exclusive). If omitted, the whole slice until\nthe end of the string is extracted. If negative, indexes from the\nback.

","example":null,"types":["none","int"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"count","details":"

The number of bytes to extract. This is equivalent to passing\nstart + count as the end position. Mutually exclusive with end.

","example":null,"types":["int"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]},{"path":["str"],"name":"clusters","title":"Clusters","keywords":[],"oneliner":"Returns the grapheme clusters of the string as an array of substrings.","element":false,"contextual":false,"deprecation":null,"details":"

Returns the grapheme clusters of the string as an array of substrings.

","example":null,"self":true,"params":[],"returns":["array"],"scope":[]},{"path":["str"],"name":"codepoints","title":"Codepoints","keywords":[],"oneliner":"Returns the Unicode codepoints of the string as an array of substrings.","element":false,"contextual":false,"deprecation":null,"details":"

Returns the Unicode codepoints of the string as an array of substrings.

","example":null,"self":true,"params":[],"returns":["array"],"scope":[]},{"path":["str"],"name":"to-unicode","title":"To Unicode","keywords":[],"oneliner":"Converts a character into its corresponding code point.","element":false,"contextual":false,"deprecation":null,"details":"

Converts a character into its corresponding code point.

","example":"
#"a".to-unicode() \\\n#("a\\u{0300}"\n   .codepoints()\n   .map(str.to-unicode))\n
\"Preview\"
","self":false,"params":[{"name":"character","details":"

The character that should be converted.

","example":null,"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["str"],"name":"from-unicode","title":"From Unicode","keywords":[],"oneliner":"Converts a unicode code point into its corresponding string.","element":false,"contextual":false,"deprecation":null,"details":"

Converts a unicode code point into its corresponding string.

","example":"
#str.from-unicode(97)\n
\"Preview\"
","self":false,"params":[{"name":"value","details":"

The code point that should be converted.

","example":null,"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["str"],"scope":[]},{"path":["str"],"name":"contains","title":"Contains","keywords":[],"oneliner":"Whether the string contains the specified pattern.","element":false,"contextual":false,"deprecation":null,"details":"

Whether the string contains the specified pattern.

\n

This method also has dedicated syntax: You can write "bc" in "abcd"\ninstead of "abcd".contains("bc").

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["str"],"name":"starts-with","title":"Starts With","keywords":[],"oneliner":"Whether the string starts with the specified pattern.","element":false,"contextual":false,"deprecation":null,"details":"

Whether the string starts with the specified pattern.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern the string might start with.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["str"],"name":"ends-with","title":"Ends With","keywords":[],"oneliner":"Whether the string ends with the specified pattern.","element":false,"contextual":false,"deprecation":null,"details":"

Whether the string ends with the specified pattern.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern the string might end with.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["str"],"name":"find","title":"Find","keywords":[],"oneliner":"Searches for the specified pattern in the string and returns the first","element":false,"contextual":false,"deprecation":null,"details":"

Searches for the specified pattern in the string and returns the first\nmatch as a string or none if there is no match.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["none","str"],"scope":[]},{"path":["str"],"name":"position","title":"Position","keywords":[],"oneliner":"Searches for the specified pattern in the string and returns the index","element":false,"contextual":false,"deprecation":null,"details":"

Searches for the specified pattern in the string and returns the index\nof the first match as an integer or none if there is no match.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["none","int"],"scope":[]},{"path":["str"],"name":"match","title":"Match","keywords":[],"oneliner":"Searches for the specified pattern in the string and returns a","element":false,"contextual":false,"deprecation":null,"details":"

Searches for the specified pattern in the string and returns a\ndictionary with details about the first match or none if there is no\nmatch.

\n

The returned dictionary has the following keys:

\n","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["none","dictionary"],"scope":[]},{"path":["str"],"name":"matches","title":"Matches","keywords":[],"oneliner":"Searches for the specified pattern in the string and returns an array of","element":false,"contextual":false,"deprecation":null,"details":"

Searches for the specified pattern in the string and returns an array of\ndictionaries with details about all matches. For details about the\nreturned dictionaries, see above.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["str"],"name":"replace","title":"Replace","keywords":[],"oneliner":"Replace at most `count` occurrences of the given pattern with a","element":false,"contextual":false,"deprecation":null,"details":"

Replace at most count occurrences of the given pattern with a\nreplacement string or function (beginning from the start). If no count\nis given, all occurrences are replaced.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for.

","example":null,"types":["str","regex"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"replacement","details":"

The string to replace the matches with or a function that gets a\ndictionary for each match and can return individual replacement\nstrings.

","example":null,"types":["str","function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"count","details":"

If given, only the first count matches of the pattern are placed.

","example":null,"types":["int"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]},{"path":["str"],"name":"trim","title":"Trim","keywords":[],"oneliner":"Removes matches of a pattern from one or both sides of the string, once or","element":false,"contextual":false,"deprecation":null,"details":"

Removes matches of a pattern from one or both sides of the string, once or\nrepeatedly and returns the resulting string.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to search for. If none, trims white spaces.

","example":null,"types":["none","str","regex"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"at","details":"

Can be start or end to only trim the start or end of the\nstring. If omitted, both sides are trimmed.

","example":null,"types":["alignment"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"repeat","details":"

Whether to repeatedly removes matches of the pattern or just once.\nDefaults to true.

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]},{"path":["str"],"name":"split","title":"Split","keywords":[],"oneliner":"Splits a string at matches of a specified pattern and returns an array","element":false,"contextual":false,"deprecation":null,"details":"

Splits a string at matches of a specified pattern and returns an array\nof the resulting parts.

\n

When the empty string is used as a separator, it separates every\ncharacter (i.e., Unicode code point) in the string, along with the\nbeginning and end of the string. In practice, this means that the\nresulting list of parts will contain the empty string at the start\nand end of the list.

","example":null,"self":true,"params":[{"name":"pattern","details":"

The pattern to split at. Defaults to whitespace.

","example":null,"types":["none","str","regex"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["str"],"name":"rev","title":"Reverse","keywords":[],"oneliner":"Reverse the string.","element":false,"contextual":false,"deprecation":null,"details":"

Reverse the string.

","example":null,"self":true,"params":[],"returns":["str"],"scope":[]}]}}}