From 4453aa1d72d407818e0abf3939299611d5997eab Mon Sep 17 00:00:00 2001
From: Mathias Jean Johansen <mathias@mjj.io>
Date: Sun, 1 May 2022 13:14:44 +0200
Subject: Add `first` function to `String`s.

---
 src/gleam/string.gleam | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'src')

diff --git a/src/gleam/string.gleam b/src/gleam/string.gleam
index fc3071f..ac7d3aa 100644
--- a/src/gleam/string.gleam
+++ b/src/gleam/string.gleam
@@ -739,3 +739,26 @@ pub fn to_option(s: String) -> Option(String) {
     _ -> Some(s)
   }
 }
+
+/// Returns the first element in a grapheme and wraps it in an `Option(String)`.
+/// If the `String` is empty, it returns `None`. Otherwise, it returns
+/// `Some(String)`.
+///
+/// ## Examples
+///
+/// ```gleam
+/// > first("")
+/// None
+/// ```
+///
+/// ```gleam
+/// > first("icecream")
+/// Some("i")
+/// ```
+///
+pub fn first(s: String) -> Option(String) {
+  case length(s) {
+    0 -> None
+    _ -> Some(slice(s, 0, 1))
+  }
+}
-- 
cgit v1.2.3