aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorErika Rowland <accounts@erikarowland.com>2023-12-02 01:22:20 -0800
committerLouis Pilfold <louis@lpil.uk>2023-12-02 09:48:20 +0000
commita785f86f408ae4ef70baef80f68750309c54f806 (patch)
treec64ee1ab91b6b185d8a455748ba2a29fed26c13c /src
parent82559e94597d85da6064e11e6f3d8d776dbcbebc (diff)
downloadgleam_stdlib-a785f86f408ae4ef70baef80f68750309c54f806.tar.gz
gleam_stdlib-a785f86f408ae4ef70baef80f68750309c54f806.zip
docs: Add string.byte_size example
Diffstat (limited to 'src')
-rw-r--r--src/gleam/string.gleam7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/gleam/string.gleam b/src/gleam/string.gleam
index d4496f3..7254fd9 100644
--- a/src/gleam/string.gleam
+++ b/src/gleam/string.gleam
@@ -901,6 +901,13 @@ fn do_inspect(term term: anything) -> StringBuilder
/// This function runs in constant time on Erlang and in linear time on
/// JavaScript.
///
+/// ## Examples
+///
+/// ```gleam
+/// > byte_size("🏳️‍⚧️🏳️‍🌈👩🏾‍❤️‍👨🏻")
+/// 58
+/// ```
+///
@external(erlang, "erlang", "byte_size")
@external(javascript, "../gleam_stdlib.mjs", "byte_size")
pub fn byte_size(string: String) -> Int