aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/gleam/iterator.gleam8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/gleam/iterator.gleam b/src/gleam/iterator.gleam
index f0fef0d..ee38bdc 100644
--- a/src/gleam/iterator.gleam
+++ b/src/gleam/iterator.gleam
@@ -82,10 +82,16 @@ pub fn unfold(
|> Iterator
}
-// TODO: test
/// Creates an iterator that yields values created by calling a given function
/// repeatedly.
///
+/// ```gleam
+/// repeatedly(fn() { 7 })
+/// |> take(3)
+/// |> to_list
+/// // -> [7, 7, 7]
+/// ```
+///
pub fn repeatedly(f: fn() -> element) -> Iterator(element) {
unfold(Nil, fn(_) { Next(f(), Nil) })
}