Add changelog entry and function doc

lpil · May 18, 2024 · aff1545 · aff1545
1 parent 9b676d1
commit aff1545
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+- Provided functions for handling timestamp values. The `timestamp` function coerces a
+  `#(#(Int, Int, Int), #(Int, Int, Int))` value representing `#(#(year, month, day), #(hour, minute, second))` into
+  a `Value`. The `decode_timestamp` function can be used to decode a dynamic value returned from the database
+  as a timestamp in the same nested tuple format.
+
+
 ## v0.7.0 - 2024-04-05
 
 - The password is now optional in the `url_config` function, defaulting to no

diff --git a/src/gleam/pgo.gleam b/src/gleam/pgo.gleam
@@ -159,6 +159,7 @@ pub fn text(a: String) -> Value
 @external(erlang, "gleam_pgo_ffi", "coerce")
 pub fn bytea(a: BitArray) -> Value
 
+/// Coerce a timestamp represented as `#(#(year, month, day), #(hour, minute, second))` into a `Value`.
 @external(erlang, "gleam_pgo_ffi", "coerce")
 pub fn timestamp(a: #(#(Int, Int, Int), #(Int, Int, Int))) -> Value