Document options for Gnat.Jetstream.API.KV (#180)

Also ran formatter on this file Co-authored-by: Michael <[email protected]>
nats-io · Jan 1, 2025 · 8cfb6e8 · 8cfb6e8
1 parent 80afa24
commit 8cfb6e8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/gnat/jetstream/api/kv.ex b/lib/gnat/jetstream/api/kv.ex
@@ -85,6 +85,10 @@ defmodule Gnat.Jetstream.API.KV do
   @doc """
   Create a Key in a Key/Value Bucket
 
+  ## Options
+
+  * `:timeout` - receive timeout for the request
+
   ## Examples
 
       iex> :ok = Jetstream.API.KV.create_key(:gnat, "my_bucket", "my_key", "my_value")