String

Utilities for working with strings.

1

import String from "string"

Types

Type declarations included in the String module.

String.Encoding

1
2
3
4
5
6
7

enum Encoding {
  UTF8,
  UTF16_BE,
  UTF16_LE,
  UTF32_BE,
  UTF32_LE,
}

Byte encodings

Values

Functions for working with the String data type.

String.concat

1

concat : (String, String) -> String

Concatenate two strings.

Parameters:

Returns:

Examples:

1

String.concat("Foo", "Bar") == "FooBar"

String.length

1

length : String -> Number

Returns the character length of the input string.

Parameters:

Returns:

Examples:

1

String.length("Hello world") == 11

String.byteLength

1

byteLength : String -> Number

Returns the byte length of the input string.

Parameters:

Returns:

Examples:

1

String.byteLength("🌾") == 4

String.indexOf

1

indexOf : (String, String) -> Option<Number>

Finds the first position of a substring in the input string.

Parameters:

Returns:

Examples:

1

String.indexOf("world", "Hello world") == Some(6)

String.lastIndexOf

1

lastIndexOf : (String, String) -> Option<Number>

Finds the last position of a substring in the input string.

Parameters:

Returns:

Examples:

1

String.lastIndexOf("world", "Hello world world") == Some(12)

String.charCodeAt

1

charCodeAt : (Number, String) -> Number

Get the Unicode code point at the position in the input string.

Parameters:

Returns:

Examples:

1

String.charCodeAt(5, "Hello world") == 32

String.charAt

1

charAt : (Number, String) -> Char

Get the character at the position in the input string.

Parameters:

Returns:

Examples:

1

String.charAt(5, "Hello world") == ' '

String.explode

1

explode : String -> Array<Char>

Split a string into its Unicode characters.

Parameters:

Returns:

Examples:

1

String.explode("Hello") == [> 'H', 'e', 'l', 'l', 'o']

String.implode

1

implode : Array<Char> -> String

Create a string from an array of characters.

Parameters:

Returns:

Examples:

1

String.implode([> 'H', 'e', 'l', 'l', 'o']) == "Hello"

String.reverse

1

reverse : String -> String

Create a string that is the given string reversed.

Parameters:

Returns:

Examples:

1

String.reverse("olleH") == "Hello"

String.split

1

split : (String, String) -> Array<String>

Split a string by the given separator.

Parameters:

Returns:

Examples:

1

String.split(" ", "Hello world") == [> "Hello", "world"]

String.slice

1

slice : (Number, Number, String) -> String

Get a portion of a string.

Parameters:

Returns:

Examples:

1

String.slice(0, 5, "Hello world") == "Hello"

String.contains

1

contains : (String, String) -> Bool

Check if a string contains a substring.

Parameters:

Returns:

Examples:

1

String.contains("world", "Hello world") == true

String.startsWith

1

startsWith : (String, String) -> Bool

Check if a string begins with another string.

Parameters:

Returns:

Examples:

1

String.startsWith("Hello", "Hello world") == true

String.endsWith

1

endsWith : (String, String) -> Bool

Check if a string ends with another string.

Parameters:

Returns:

Examples:

1

String.endsWith("world", "Hello world") == true

String.replaceFirst

1

replaceFirst : (String, String, String) -> String

Replaces the first appearance of the search pattern in the string with the replacement value.

Parameters:

Returns:

Examples:

1

String.replaceFirst("🌾", "🌎", "Hello 🌾🌾") == "Hello 🌎🌾"

String.replaceLast

1

replaceLast : (String, String, String) -> String

Replaces the last appearance of the search pattern in the string with the replacement value.

Parameters:

Returns:

Examples:

1

String.replaceLast("🌾", "🌎", "Hello 🌾🌾") == "Hello 🌾🌎"

String.replaceAll

1

replaceAll : (String, String, String) -> String

Replaces every appearance of the search pattern in the string with the replacement value.

Parameters:

Returns:

Examples:

1

String.replaceAll("🌾", "🌎", "Hello 🌾🌾") == "Hello 🌎🌎"

String.encodeAt

1

encodeAt : (String, Encoding, Bytes, Number) -> Bytes

Encodes the given string into a byte sequence at the supplied position, excluding any byte-order marker, using the encoding scheme provided.

Parameters:

Returns:

String.encodeAtWithBom

1

encodeAtWithBom : (String, Encoding, Bytes, Number) -> Bytes

Encodes the given string into a byte sequence at the supplied position, including any byte-order marker, using the encoding scheme provided.

Parameters:

Returns:

String.encode

1

encode : (String, Encoding) -> Bytes

Encodes the given string using the given encoding scheme, excluding any byte-order marker.

Parameters:

Returns:

String.encodeWithBom

1

encodeWithBom : (String, Encoding) -> Bytes

Encodes the given string using the given encoding scheme, including any byte-order marker.

Parameters:

Returns:

String.decodeRange

1

decodeRange : (Bytes, Encoding, Number, Number) -> String

Decodes the given byte sequence of the specified range into a string, excluding any byte-order marker, using encoding scheme provided.

Parameters:

Returns:

String.decodeRangeKeepBom

1

decodeRangeKeepBom : (Bytes, Encoding, Number, Number) -> String

Decodes the given byte sequence of the specified range into a string, including any byte-order marker, using encoding scheme provided.

Parameters:

Returns:

String.decode

1

decode : (Bytes, Encoding) -> String

Decodes the given byte sequence into a string using the given encoding scheme, excluding any byte-order marker.

Parameters:

Returns:

String.decodeKeepBom

1

decodeKeepBom : (Bytes, Encoding) -> String

Decodes the given byte sequence into a string using the given encoding scheme, including any byte-order marker.

Parameters:

Returns:

String.forEachCodePoint

1

forEachCodePoint : ((Number -> Void), String) -> Void

Iterates over Unicode code points in a string.

Parameters:

Examples:

1

String.forEachCodePoint(print, "Hello world")

String.forEachCodePointi

1

forEachCodePointi : (((Number, Number) -> Void), String) -> Void

Iterates over Unicode code points in a string. This is the same as forEachCodePoint, but provides the code point’s index in the string as the second argument to the iterator function.

Parameters:

Examples:

1

String.forEachCodePointi((codepoint, index) => print((codepoint, index)), "Hello world")

String.trimStart

1

trimStart : String -> String

Trims the beginning of a string—removing any leading whitespace characters.

Parameters:

Returns:

Examples:

1

String.trimStart("   Hello World") == "Hello World"

String.trimEnd

1

trimEnd : String -> String

Trims the end of a string—removing any trailing whitespace characters.

Parameters:

Returns:

Examples:

1

String.trimEnd("Hello World   ") == "Hello World"

String.trim

1

trim : String -> String

Trims a string—removing all leading and trailing whitespace characters.

Parameters:

Returns:

Examples:

1

String.trim("   Hello World   ") == "Hello World"