@tellahq/rescript 10.1.4-republish-2 → 10.1.4-republish-3

package/lib/ocaml/js_string.ml

@@ -0,0 +1,914 @@
+(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition to the permissions granted to you by the LGPL, you may combine
+ * or link a "work that uses the Library" with a publicly distributed version
+ * of this file to produce a combined library or application, then distribute
+ * that combined work under the terms of your choosing, with no requirement
+ * to comply with the obligations normally placed on you by section 4 of the
+ * LGPL version 3 (or the corresponding section of a later version of the LGPL
+ * should you choose to use a later version).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
+
+(** JavaScript String API *)
+
+[@@@warning "-103"]
+
+type t = string
+
+external make : 'a -> t = "String"
+  [@@bs.val]
+(**
+`make(value)` converts the given value to a `string`.
+
+```res example
+Js.String2.make(3.5) == "3.5"
+Js.String2.make([1, 2, 3]) == "1,2,3"
+```
+*)
+
+external fromCharCode : int -> t = "String.fromCharCode"
+  [@@bs.val]
+(**
+`fromCharCode(n)` creates a `string` containing the character corresponding to that number; `n` ranges from 0 to 65535.
+If out of range, the lower 16 bits of the value are used. Thus, `fromCharCode(0x1F63A)` gives the same result as `fromCharCode(0xF63A)`. See [`String.fromCharCode`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCharCode) on MDN.
+
+```res example
+Js.String2.fromCharCode(65) == "A"
+Js.String2.fromCharCode(0x3c8) == `ψ`
+Js.String2.fromCharCode(0xd55c) == `한`
+Js.String2.fromCharCode(-64568) == `ψ`
+```
+*)
+
+external fromCharCodeMany : int array -> t = "String.fromCharCode"
+  [@@bs.val] [@@bs.splice]
+(**
+`fromCharCodeMany([n1, n2, n3])` creates a `string` from the characters
+corresponding to the given numbers, using the same rules as `fromCharCode`. See
+[`String.fromCharCode`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCharCode)
+on MDN.
+*)
+
+external fromCodePoint : int -> t = "String.fromCodePoint"
+  [@@bs.val]
+(**
+`fromCodePoint(n)` creates a `string` containing the character corresponding to
+that numeric code point. If the number is not a valid code point, it raises
+`RangeError`.Thus, `fromCodePoint(0x1F63A)` will produce a correct value,
+unlike `fromCharCode(0x1F63A)`, and `fromCodePoint(-5)` will raise a
+`RangeError`.
+
+See [`String.fromCodePoint`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCodePoint)
+on MDN.
+
+```res example
+Js.String2.fromCodePoint(65) == "A"
+Js.String2.fromCodePoint(0x3c8) == `ψ`
+Js.String2.fromCodePoint(0xd55c) == `한`
+Js.String2.fromCodePoint(0x1f63a) == `😺`
+```
+*)
+
+external fromCodePointMany : int array -> t = "String.fromCodePoint"
+  [@@bs.val] [@@bs.splice]
+(**
+`fromCodePointMany([n1, n2, n3])` creates a `string` from the characters
+corresponding to the given code point numbers, using the same rules as
+`fromCodePoint`.
+
+See [`String.fromCodePoint`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/fromCodePoint)
+on MDN.
+
+```res example
+Js.String2.fromCodePointMany([0xd55c, 0xae00, 0x1f63a]) == `한글😺`
+```
+*)
+
+(* String.raw: ES2015, meant to be used with template strings, not directly *)
+
+external length : t -> int = "length"
+  [@@bs.get]
+(**
+`length(s)` returns the length of the given `string`. See
+[`String.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length)
+on MDN.
+
+```res example
+Js.String2.length("abcd") == 4
+```
+*)
+
+external get : t -> int -> t = ""
+  [@@bs.get_index]
+(**
+`get(s, n)` returns as a `string` the character at the given index number. If
+`n` is out of range, this function returns `undefined`, so at some point this
+function may be modified to return `option(string)`.
+
+```res example
+Js.String2.get("Reason", 0) == "R"
+Js.String2.get("Reason", 4) == "o"
+Js.String2.get(`Rẽasöń`, 5) == `ń`
+```
+*)
+
+external charAt : int -> t = "charAt"
+  [@@bs.send.pipe: t]
+(**
+`charAt(n, s)` gets the character at index `n` within string `s`. If `n` is
+negative or greater than the length of `s`, it returns the empty string. If the
+string contains characters outside the range \u0000-\uffff, it will return the
+first 16-bit value at that position in the string.
+
+See [`String.charAt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/charAt)
+on MDN.
+
+```res example
+Js.String.charAt(0, "Reason") == "R"
+Js.String.charAt(12, "Reason") == ""
+Js.String.charAt(5, `Rẽasöń`) == `ń`
+```
+*)
+
+external charCodeAt : int -> float = "charCodeAt"
+  [@@bs.send.pipe: t]
+(**
+`charCodeAt(n, s)` returns the character code at position `n` in string `s`;
+the result is in the range 0-65535, unlke `codePointAt`, so it will not work
+correctly for characters with code points greater than or equal to 0x10000. The
+return type is `float` because this function returns NaN if `n` is less than
+zero or greater than the length of the string.
+
+See [`String.charCodeAt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/charCodeAt)
+on MDN.
+
+```res example
+Js.String.charCodeAt(0, `😺`) == 0xd83d->Belt.Int.toFloat
+Js.String.codePointAt(0, `😺`) == Some(0x1f63a)
+```
+*)
+
+external codePointAt : int -> int option = "codePointAt"
+  [@@bs.send.pipe: t]
+(**
+`codePointAt(n, s)` returns the code point at position `n` within string `s` as
+a `Some(value)`. The return value handles code points greater than or equal to
+0x10000. If there is no code point at the given position, the function returns
+`None`.
+
+See [`String.codePointAt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/codePointAt)
+on MDN.
+
+```res example
+Js.String.codePointAt(1, `¿😺?`) == Some(0x1f63a)
+Js.String.codePointAt(5, "abc") == None
+```
+*)
+
+external concat : t -> t = "concat"
+  [@@bs.send.pipe: t]
+(**
+`concat(append, original)` returns a new `string` with `append` added after
+`original`.
+
+See [`String.concat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/concat)
+on MDN.
+
+```res example
+Js.String.concat("bell", "cow") == "cowbell"
+```
+*)
+
+external concatMany : t array -> t = "concat"
+  [@@bs.send.pipe: t] [@@bs.splice]
+(**
+`concat(arr, original)` returns a new `string` consisting of each item of an
+array of strings added to the `original` string.
+
+See [`String.concat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/concat)
+on MDN.
+
+```res example
+Js.String.concatMany(["2nd", "3rd", "4th"], "1st") == "1st2nd3rd4th"
+```
+*)
+
+external endsWith : t -> bool = "endsWith"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `endsWith(substr, str)` returns `true` if the `str` ends with `substr`,
+`false` otherwise.
+
+See [`String.endsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith)
+on MDN.
+
+```res example
+Js.String.endsWith("Script", "BuckleScript") == true
+Js.String.endsWith("Script", "BuckleShoes") == false
+```
+*)
+
+external endsWithFrom : t -> int -> bool = "endsWith"
+  [@@bs.send.pipe: t]
+(**
+`endsWithFrom(ending, len, str)` returns `true` if the first len characters of
+`str` end with `ending`, `false` otherwise. If `len` is greater than or equal
+to the length of `str`, then it works like `endsWith`. (Honestly, this should
+have been named endsWithAt, but oh well.)
+
+See [`String.endsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith)
+on MDN.
+
+```res example
+Js.String.endsWithFrom("cd", 4, "abcd") == true
+Js.String.endsWithFrom("cd", 3, "abcde") == false
+Js.String.endsWithFrom("cde", 99, "abcde") == true
+Js.String.endsWithFrom("ple", 7, "example.dat") == true
+```
+*)
+
+external includes : t -> bool = "includes"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `includes(searchValue, str)` returns `true` if `searchValue` is found
+anywhere within `str`, false otherwise.
+
+See [`String.includes`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes)
+on MDN.
+
+```res example
+Js.String.includes("gram", "programmer") == true
+Js.String.includes("er", "programmer") == true
+Js.String.includes("pro", "programmer") == true
+Js.String.includes("xyz", "programmer.dat") == false
+```
+*)
+
+external includesFrom : t -> int -> bool = "includes"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `includes(searchValue start, str)` returns `true` if `searchValue` is
+found anywhere within `str` starting at character number `start` (where 0 is
+the first character), `false` otherwise.
+
+See [`String.includes`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes)
+on MDN.
+
+```res example
+Js.String.includesFrom("gram", 1, "programmer") == true
+Js.String.includesFrom("gram", 4, "programmer") == false
+Js.String.includesFrom(`한`, 1, `대한민국`) == true
+```
+*)
+
+external indexOf : t -> int = "indexOf"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `indexOf(searchValue, str)` returns the position at which `searchValue`
+was first found within `str`, or -1 if `searchValue` is not in `str`.
+
+See [`String.indexOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf)
+on MDN.
+
+```res example
+Js.String.indexOf("ok", "bookseller") == 2
+Js.String.indexOf("sell", "bookseller") == 4
+Js.String.indexOf("ee", "beekeeper") == 1
+Js.String.indexOf("xyz", "bookseller") == -1
+```
+*)
+
+external indexOfFrom : t -> int -> int = "indexOf"
+  [@@bs.send.pipe: t]
+(**
+`indexOfFrom(searchValue, start, str)` returns the position at which
+`searchValue` was found within `str` starting at character position `start`, or
+-1 if `searchValue` is not found in that portion of `str`. The return value is
+relative to the beginning of the string, no matter where the search started
+from.
+
+See [`String.indexOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf)
+on MDN.
+
+```res example
+Js.String.indexOfFrom("ok", 1, "bookseller") == 2
+Js.String.indexOfFrom("sell", 2, "bookseller") == 4
+Js.String.indexOfFrom("sell", 5, "bookseller") == -1
+```
+*)
+
+external lastIndexOf : t -> int = "lastIndexOf"
+  [@@bs.send.pipe: t]
+(**
+`lastIndexOf(searchValue, str)` returns the position of the last occurrence of
+`searchValue` within `str`, searching backwards from the end of the string.
+Returns -1 if `searchValue` is not in `str`. The return value is always
+relative to the beginning of the string.
+
+See [`String.lastIndexOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf)
+on MDN.
+
+```res example
+Js.String.lastIndexOf("ok", "bookseller") == 2
+Js.String.lastIndexOf("ee", "beekeeper") == 4
+Js.String.lastIndexOf("xyz", "abcdefg") == -1
+```
+*)
+
+external lastIndexOfFrom : t -> int -> int = "lastIndexOf"
+  [@@bs.send.pipe: t]
+(**
+`lastIndexOfFrom(searchValue, start, str)` returns the position of the last
+occurrence of `searchValue` within `str`, searching backwards from the given
+start position. Returns -1 if `searchValue` is not in `str`. The return value
+is always relative to the beginning of the string.
+
+See [`String.lastIndexOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf)
+on MDN.
+
+```res example
+Js.String.lastIndexOfFrom("ok", 6, "bookseller") == 2
+Js.String.lastIndexOfFrom("ee", 8, "beekeeper") == 4
+Js.String.lastIndexOfFrom("ee", 3, "beekeeper") == 1
+Js.String.lastIndexOfFrom("xyz", 4, "abcdefg") == -1
+```
+*)
+
+(* extended by ECMA-402 *)
+
+external localeCompare : t -> float = "localeCompare"
+  [@@bs.send.pipe: t]
+(**
+`localeCompare(comparison, reference)` returns
+- a negative value if reference comes before comparison in sort order
+- zero if reference and comparison have the same sort order
+- a positive value if reference comes after comparison in sort order
+
+See [`String.localeCompare`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare) on MDN.
+
+```res example
+Js.String.localeCompare("ant", "zebra") > 0.0
+Js.String.localeCompare("zebra", "ant") < 0.0
+Js.String.localeCompare("cat", "cat") == 0.0
+Js.String.localeCompare("cat", "CAT") > 0.0
+```
+*)
+
+external match_ : Js_re.t -> t option array option = "match"
+  [@@bs.send.pipe: t] [@@bs.return { null_to_opt }]
+(**
+`match(regexp, str)` matches a `string` against the given `regexp`. If there is
+no match, it returns `None`. For regular expressions without the g modifier, if
+  there is a match, the return value is `Some(array)` where the array contains:
+- The entire matched string
+- Any capture groups if the regexp had parentheses
+
+For regular expressions with the g modifier, a matched expression returns
+`Some(array)` with all the matched substrings and no capture groups.
+
+See [`String.match`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match)
+on MDN.
+
+```res example
+Js.String.match_(%re("/b[aeiou]t/"), "The better bats") == Some(["bet"])
+Js.String.match_(%re("/b[aeiou]t/g"), "The better bats") == Some(["bet", "bat"])
+Js.String.match_(%re("/(\d+)-(\d+)-(\d+)/"), "Today is 2018-04-05.") ==
+  Some(["2018-04-05", "2018", "04", "05"])
+Js.String.match_(%re("/b[aeiou]g/"), "The large container.") == None
+```
+*)
+
+external normalize : t = "normalize"
+  [@@bs.send.pipe: t]
+(**
+`normalize(str)` returns the normalized Unicode string using Normalization Form
+Canonical (NFC) Composition. Consider the character ã, which can be represented
+as the single codepoint \u00e3 or the combination of a lower case letter A
+\u0061 and a combining tilde \u0303. Normalization ensures that both can be
+stored in an equivalent binary representation.
+
+See [`String.normalize`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize)
+on MDN.
+
+See also [Unicode technical report #15](https://unicode.org/reports/tr15/) for
+details.
+*)
+
+external normalizeByForm : t -> t = "normalize"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `normalize(form, str)` returns the normalized Unicode string using the specified form of normalization, which may be one of:
+- "NFC" — Normalization Form Canonical Composition.
+- "NFD" — Normalization Form Canonical Decomposition.
+- "NFKC" — Normalization Form Compatibility Composition.
+- "NFKD" — Normalization Form Compatibility Decomposition.
+
+See [`String.normalize`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize) on MDN.
+
+See also [Unicode technical report #15](https://unicode.org/reports/tr15/) for details.
+*)
+
+external repeat : int -> t = "repeat"
+  [@@bs.send.pipe: t]
+(**
+`repeat(n, str)` returns a `string` that consists of `n` repetitions of `str`.
+Raises `RangeError` if `n` is negative.
+
+See [`String.repeat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/repeat)
+on MDN.
+
+```res example
+Js.String.repeat(3, "ha") == "hahaha"
+Js.String.repeat(0, "empty") == ""
+```
+*)
+
+external replace : t -> t -> t = "replace"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `replace(substr, newSubstr, str)` returns a new `string` which is
+identical to `str` except with the first matching instance of `substr` replaced
+by `newSubstr`. `substr` is treated as a verbatim string to match, not a
+regular expression.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+
+```res example
+Js.String.replace("old", "new", "old string") == "new string"
+Js.String.replace("the", "this", "the cat and the dog") == "this cat and the dog"
+```
+*)
+
+external replaceByRe : Js_re.t -> t -> t = "replace"
+  [@@bs.send.pipe: t]
+(**
+`replaceByRe(regex, replacement, str)` returns a new `string` where occurrences
+matching regex have been replaced by `replacement`.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+
+```res example
+Js.String.replaceByRe(%re("/[aeiou]/g"), "x", "vowels be gone") == "vxwxls bx gxnx"
+Js.String.replaceByRe(%re("/(\w+) (\w+)/"), "$2, $1", "Juan Fulano") == "Fulano, Juan"
+```
+*)
+
+external unsafeReplaceBy0 : Js_re.t -> ((t -> int -> t -> t)[@bs.uncurry]) -> t
+  = "replace"
+  [@@bs.send.pipe: t]
+(**
+Returns a new `string` with some or all matches of a pattern with no capturing
+parentheses replaced by the value returned from the given function. The
+function receives as its parameters the matched string, the offset at which the
+match begins, and the whole string being matched.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+
+```res example
+let str = "beautiful vowels"
+let re = %re("/[aeiou]/g")
+let matchFn = (matchPart, _offset, _wholeString) => Js.String.toUpperCase(matchPart)
+
+Js.String.unsafeReplaceBy0(re, matchFn, str) == "bEAUtIfUl vOwEls"
+```
+*)
+
+external unsafeReplaceBy1 :
+  Js_re.t -> ((t -> t -> int -> t -> t)[@bs.uncurry]) -> t = "replace"
+  [@@bs.send.pipe: t]
+(**
+Returns a new `string` with some or all matches of a pattern with one set of
+capturing parentheses replaced by the value returned from the given function.
+The function receives as its parameters the matched string, the captured
+string, the offset at which the match begins, and the whole string being
+matched.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+
+```res example
+let str = "Jony is 40"
+let re = %re("/(Jony is )\d+/g")
+let matchFn = (_match, part1, _offset, _wholeString) => {
+  part1 ++ "41"
+}
+
+Js.String.unsafeReplaceBy1(re, matchFn, str) == "Jony is 41"
+```
+*)
+
+external unsafeReplaceBy2 :
+  Js_re.t -> ((t -> t -> t -> int -> t -> t)[@bs.uncurry]) -> t = "replace"
+  [@@bs.send.pipe: t]
+(**
+Returns a new `string` with some or all matches of a pattern with two sets of
+capturing parentheses replaced by the value returned from the given function.
+The function receives as its parameters the matched string, the captured
+strings, the offset at which the match begins, and the whole string being
+matched.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+
+```res example
+let str = "7 times 6"
+let re = %re("/(\d+) times (\d+)/")
+let matchFn = (_match, p1, p2, _offset, _wholeString) => {
+  switch (Belt.Int.fromString(p1), Belt.Int.fromString(p2)) {
+  | (Some(x), Some(y)) => Belt.Int.toString(x * y)
+  | _ => "???"
+  }
+}
+
+Js.String.unsafeReplaceBy2(re, matchFn, str) == "42"
+```
+*)
+
+external unsafeReplaceBy3 :
+  Js_re.t -> ((t -> t -> t -> t -> int -> t -> t)[@bs.uncurry]) -> t = "replace"
+  [@@bs.send.pipe: t]
+(**
+Returns a new `string` with some or all matches of a pattern with three sets of
+capturing parentheses replaced by the value returned from the given function.
+The function receives as its parameters the matched string, the captured
+strings, the offset at which the match begins, and the whole string being
+matched.
+
+See [`String.replace`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace)
+on MDN.
+*)
+
+external search : Js_re.t -> int = "search"
+  [@@bs.send.pipe: t]
+(**
+`search(regexp, str)` returns the starting position of the first match of
+`regexp` in the given `str`, or -1 if there is no match.
+
+See [`String.search`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/search)
+on MDN.
+
+```res example
+Js.String.search(%re("/\d+/"), "testing 1 2 3") == 8
+Js.String.search(%re("/\d+/"), "no numbers") == -1
+```
+*)
+
+external slice : from:int -> to_:int -> t = "slice"
+  [@@bs.send.pipe: t]
+(**
+`slice(from:n1, to_:n2, str)` returns the substring of `str` starting at
+character `n1` up to but not including `n2`.
+- If either `n1` or `n2` is negative, then it is evaluated as `length(str - n1)` or `length(str - n2)`.
+- If `n2` is greater than the length of `str`, then it is treated as `length(str)`.
+- If `n1` is greater than `n2`, slice returns the empty string.
+
+See [`String.slice`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice) on MDN.
+
+```res example
+Js.String.slice(~from=2, ~to_=5, "abcdefg") == "cde"
+Js.String.slice(~from=2, ~to_=9, "abcdefg") == "cdefg"
+Js.String.slice(~from=-4, ~to_=-2, "abcdefg") == "de"
+Js.String.slice(~from=5, ~to_=1, "abcdefg") == ""
+```
+*)
+
+external sliceToEnd : from:int -> t = "slice"
+  [@@bs.send.pipe: t]
+(**
+`sliceToEnd(str, from:n)` returns the substring of `str` starting at character
+`n` to the end of the string.
+- If `n` is negative, then it is evaluated as `length(str - n)`.
+- If `n` is greater than the length of `str`, then sliceToEnd returns the empty string.
+
+See [`String.slice`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice) on MDN.
+
+```res example
+Js.String.sliceToEnd(~from=4, "abcdefg") == "efg"
+Js.String.sliceToEnd(~from=-2, "abcdefg") == "fg"
+Js.String.sliceToEnd(~from=7, "abcdefg") == ""
+```
+*)
+
+external split : t -> t array = "split"
+  [@@bs.send.pipe: t]
+(**
+`split(delimiter, str)` splits the given `str` at every occurrence of
+`delimiter` and returns an array of the resulting substrings.
+
+See [`String.split`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+on MDN.
+
+```res example
+Js.String.split("-", "2018-01-02") == ["2018", "01", "02"]
+Js.String.split(",", "a,b,,c") == ["a", "b", "", "c"]
+Js.String.split("::", "good::bad as great::awful") == ["good", "bad as great", "awful"]
+Js.String.split(";", "has-no-delimiter") == ["has-no-delimiter"]
+```
+*)
+
+external splitAtMost : t -> limit:int -> t array = "split"
+  [@@bs.send.pipe: t]
+(**
+`splitAtMost(delimiter, ~limit:n, str)` splits the given `str` at every
+occurrence of `delimiter` and returns an array of the first `n` resulting
+substrings. If `n` is negative or greater than the number of substrings, the
+array will contain all the substrings.
+
+See [`String.split`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+on MDN.
+
+```res example
+Js.String.splitAtMost("/", ~limit=3, "ant/bee/cat/dog/elk") == ["ant", "bee", "cat"]
+Js.String.splitAtMost("/", ~limit=0, "ant/bee/cat/dog/elk") == []
+Js.String.splitAtMost("/", ~limit=9, "ant/bee/cat/dog/elk") == ["ant", "bee", "cat", "dog", "elk"]
+```
+*)
+
+external splitByRe : Js_re.t -> t option array = "split"
+  [@@bs.send.pipe: t]
+(**
+`splitByRe(regex, str)` splits the given `str` at every occurrence of `regex`
+and returns an array of the resulting substrings.
+
+See [`String.split`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+on MDN.
+
+```res example
+Js.String.splitByRe(%re("/\s*[,;]\s*/"), "art; bed , cog ;dad") == [
+    Some("art"),
+    Some("bed"),
+    Some("cog"),
+    Some("dad"),
+  ]
+```
+*)
+
+external splitByReAtMost : Js_re.t -> limit:int -> t option array = "split"
+  [@@bs.send.pipe: t]
+(**
+`splitByReAtMost(regex, ~limit:n, str)` splits the given `str` at every
+occurrence of `regex` and returns an array of the first `n` resulting
+substrings. If `n` is negative or greater than the number of substrings, the
+array will contain all the substrings.
+
+See [`String.split`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+on MDN.
+
+```res example
+Js.String.splitByReAtMost(%re("/\s*:\s*/"), ~limit=3, "one: two: three: four") == [
+    Some("one"),
+    Some("two"),
+    Some("three"),
+  ]
+
+Js.String.splitByReAtMost(%re("/\s*:\s*/"), ~limit=0, "one: two: three: four") == []
+
+Js.String.splitByReAtMost(%re("/\s*:\s*/"), ~limit=8, "one: two: three: four") == [
+    Some("one"),
+    Some("two"),
+    Some("three"),
+    Some("four"),
+  ]
+```
+*)
+
+external startsWith : t -> bool = "startsWith"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `startsWith(substr, str)` returns `true` if the `str` starts with
+`substr`, `false` otherwise.
+
+See [`String.startsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith)
+on MDN.
+
+```res example
+Js.String.startsWith("Buckle", "BuckleScript") == true
+Js.String.startsWith("", "BuckleScript") == true
+Js.String.startsWith("Buckle", "JavaScript") == false
+```
+*)
+
+external startsWithFrom : t -> int -> bool = "startsWith"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `startsWithFrom(substr, n, str)` returns `true` if the `str` starts
+with `substr` starting at position `n`, false otherwise. If `n` is negative,
+the search starts at the beginning of `str`.
+
+See [`String.startsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith)
+on MDN.
+
+```res example
+Js.String.startsWithFrom("kle", 3, "BuckleScript") == true
+Js.String.startsWithFrom("", 3, "BuckleScript") == true
+Js.String.startsWithFrom("Buckle", 2, "JavaScript") == false
+```
+*)
+
+external substr : from:int -> t = "substr"
+  [@@bs.send.pipe: t]
+(**
+`substr(~from:n, str)` returns the substring of `str` from position `n` to the
+end of the string.
+- If `n` is less than zero, the starting position is the length of `str - n`.
+- If `n` is greater than or equal to the length of `str`, returns the empty string.
+
+JavaScript’s `String.substr()` is a legacy function. When possible, use
+`substring()` instead.
+
+See [`String.substr`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr)
+on MDN.
+
+```res example
+Js.String.substr(~from=3, "abcdefghij") == "defghij"
+Js.String.substr(~from=-3, "abcdefghij") == "hij"
+Js.String.substr(~from=12, "abcdefghij") == ""
+```
+*)
+
+external substrAtMost : from:int -> length:int -> t = "substr"
+  [@@bs.send.pipe: t]
+(**
+`substrAtMost(~from: pos, ~length: n, str)` returns the substring of `str` of
+length `n` starting at position `pos`.
+- If `pos` is less than zero, the starting position is the length of `str - pos`.
+- If `pos` is greater than or equal to the length of `str`, returns the empty string.
+- If `n` is less than or equal to zero, returns the empty string.
+
+JavaScript’s `String.substr()` is a legacy function. When possible, use
+`substring()` instead.
+
+See [`String.substr`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr)
+on MDN.
+
+```res example
+Js.String.substrAtMost(~from=3, ~length=4, "abcdefghij") == "defg"
+Js.String.substrAtMost(~from=-3, ~length=4, "abcdefghij") == "hij"
+Js.String.substrAtMost(~from=12, ~length=2, "abcdefghij") == ""
+```
+*)
+
+external substring : from:int -> to_:int -> t = "substring"
+  [@@bs.send.pipe: t]
+(**
+`substring(~from: start, ~to_: finish, str)` returns characters `start` up to
+but not including finish from `str`.
+- If `start` is less than zero, it is treated as zero.
+- If `finish` is zero or negative, the empty string is returned.
+- If `start` is greater than `finish`, the `start` and `finish` points are swapped.
+
+See [`String.substring`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring) on MDN.
+
+```res example
+Js.String.substring(~from=3, ~to_=6, "playground") == "ygr"
+Js.String.substring(~from=6, ~to_=3, "playground") == "ygr"
+Js.String.substring(~from=4, ~to_=12, "playground") == "ground"
+```
+*)
+
+external substringToEnd : from:int -> t = "substring"
+  [@@bs.send.pipe: t]
+(**
+`substringToEnd(~from: start, str)` returns the substring of `str` from
+position `start` to the end.
+- If `start` is less than or equal to zero, the entire string is returned.
+- If `start` is greater than or equal to the length of `str`, the empty string is returned.
+
+See [`String.substring`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring) on MDN.
+
+```res example
+Js.String.substringToEnd(~from=4, "playground") == "ground"
+Js.String.substringToEnd(~from=-3, "playground") == "playground"
+Js.String.substringToEnd(~from=12, "playground") == ""
+```
+*)
+
+external toLowerCase : t = "toLowerCase"
+  [@@bs.send.pipe: t]
+(**
+`toLowerCase(str)` converts `str` to lower case using the locale-insensitive
+case mappings in the Unicode Character Database. Notice that the conversion can
+give different results depending upon context, for example with the Greek
+letter sigma, which has two different lower case forms; one when it is the last
+character in a string and another when it is not.
+
+See [`String.toLowerCase`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toLowerCase)
+on MDN.
+
+```res example
+Js.String.toLowerCase("ABC") == "abc"
+Js.String.toLowerCase(`ΣΠ`) == `σπ`
+Js.String.toLowerCase(`ΠΣ`) == `πς`
+```
+*)
+
+external toLocaleLowerCase : t = "toLocaleLowerCase"
+  [@@bs.send.pipe: t]
+(**
+`toLocaleLowerCase(str)` converts `str` to lower case using the current locale.
+
+See [`String.toLocaleLowerCase`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toLocaleLowerCase)
+on MDN.
+*)
+
+external toUpperCase : t = "toUpperCase"
+  [@@bs.send.pipe: t]
+(**
+`toUpperCase(str)` converts `str` to upper case using the locale-insensitive
+case mappings in the Unicode Character Database. Notice that the conversion can
+expand the number of letters in the result; for example the German ß
+capitalizes to two Ses in a row.
+
+See [`String.toUpperCase`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toUpperCase)
+on MDN.
+
+```res example
+Js.String.toUpperCase("abc") == "ABC"
+Js.String.toUpperCase(`Straße`) == `STRASSE`
+Js.String.toUpperCase(`πς`) == `ΠΣ`
+```
+*)
+
+external toLocaleUpperCase : t = "toLocaleUpperCase"
+  [@@bs.send.pipe: t]
+(**
+`toLocaleUpperCase(str)` converts `str` to upper case using the current locale.
+
+See [`String.to:LocaleUpperCase`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toLocaleUpperCase)
+on MDN.
+*)
+
+external trim : t = "trim"
+  [@@bs.send.pipe: t]
+(**
+`trim(str)` returns a string that is `str` with whitespace stripped from both
+ends. Internal whitespace is not removed.
+
+See [`String.trim`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trim)
+on MDN.
+
+```res example
+Js.String.trim("   abc def   ") == "abc def"
+Js.String.trim("\n\r\t abc def \n\n\t\r ") == "abc def"
+```
+*)
+
+(* HTML wrappers *)
+
+external anchor : t -> t = "anchor"
+  [@@bs.send.pipe: t]
+(**
+`anchor(anchorName, anchorText)` creates a string with an HTML `<a>` element
+with name attribute of `anchorName` and `anchorText` as its content. Please do
+not use this method, as it has been removed from the relevant web standards.
+
+See [`String.anchor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/anchor)
+on MDN.
+
+```res example
+Js.String.anchor("page1", "Page One") == "<a name=\"page1\">Page One</a>"
+```
+*)
+
+external link : t -> t = "link"
+  [@@bs.send.pipe: t]
+(**
+ES2015: `link(urlText, linkText)` creates a string with an HTML `<a>` element
+with href attribute of `urlText` and `linkText` as its content. Please do not
+use this method, as it has been removed from the relevant web standards.
+
+See [`String.link`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/link)
+on MDN.
+
+```res example
+Js.String.link("page2.html", "Go to page two") == "<a href=\"page2.html\">Go to page two</a>"
+```
+*)
+
+external castToArrayLike : t -> t Js_array2.array_like = "%identity"
+(**
+Casts its argument to an `array_like` entity that can be processed by functions
+such as `Js.Array2.fromMap()`
+
+```res example
+let s = "abcde"
+let arr = Js.Array2.fromMap(Js.String.castToArrayLike(s), x => x)
+arr == ["a", "b", "c", "d", "e"]
+```
+*)