Release 0.10.0

cheerfulstoic · Aug 16, 2024 · e4b196c · e4b196c
1 parent eb052dc
commit e4b196c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 **IMPORTANT NOTE**: Make sure to see the [Upgrading Versions](guides/howtos/Upgrading Versions.md) guide in the [HexDocs documentation](https://hexdocs.pm/ecto_watch) if you're having an issue after upgrading.
 
+## [0.10.0] - 2023-08-16
+
+### Added
+
+- Add `EctoWatch.details/1` function to get details about a watcher (#17 / thanks @frerich)
+
 ## [0.9.11] - 2023-08-12
 
 ### Fixed

diff --git a/lib/ecto_watch.ex b/lib/ecto_watch.ex
@@ -160,10 +160,18 @@ defmodule EctoWatch do
   Returns details about a watcher for reflection purposes
 
   For example if you need to know what the function/triggers are in the database.
+
+  Examples:
+
+      iex> EctoWatch.subscribe({Comment, :updated})
+
+    Or for a label:
+
+      iex> EctoWatch.subscribe(:comment_updated_custom)
   """
   @spec details(watcher_identifier()) :: %{
           repo_mod: module(),
-          schema_definition: %EctoWatch.Options.WatcherOptions.SchemaDefinition{
+          schema_definition: %{
             schema_prefix: binary(),
             table_name: binary(),
             primary_key: binary(),

diff --git a/mix.exs b/mix.exs
@@ -6,7 +6,7 @@ defmodule EctoWatch.MixProject do
   def project do
     [
       app: :ecto_watch,
-      version: "0.9.11",
+      version: "0.10.0",
       elixir: "~> 1.10",
       description:
         "EctoWatch allows you to easily get Phoenix.PubSub notifications directly from postgresql.",