Add Psalm annotations to query and command buses to provide type info…

…rmation for return values (#15)
spiral-packages · Nov 30, 2023 · 8782a5b · 8782a5b
1 parent 134c202
commit 8782a5b
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/src/CommandBusInterface.php b/src/CommandBusInterface.php
@@ -6,5 +6,11 @@
 
 interface CommandBusInterface
 {
+    /**
+     * @template TResult
+     * @param CommandInterface<TResult> $command
+     *
+     * @return TResult
+     */
     public function dispatch(CommandInterface $command): mixed;
 }
diff --git a/src/CommandInterface.php b/src/CommandInterface.php
@@ -4,6 +4,9 @@
 
 namespace Spiral\Cqrs;
 
+/**
+ * @template TResult
+ */
 interface CommandInterface
 {
 

diff --git a/src/QueryBusInterface.php b/src/QueryBusInterface.php
@@ -6,5 +6,11 @@
 
 interface QueryBusInterface
 {
+    /**
+     * @template TResult
+     * @param QueryInterface<TResult> $query
+     *
+     * @return TResult
+     */
     public function ask(QueryInterface $query): mixed;
 }
diff --git a/src/QueryInterface.php b/src/QueryInterface.php
@@ -4,6 +4,9 @@
 
 namespace Spiral\Cqrs;
 
+/**
+ * @template TResult
+ */
 interface QueryInterface
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,9 @@ @@
     namespace Spiral\Cqrs;
+    /**
+     * @template TResult
+     */
     interface CommandInterface
     {
@@ Expand Down @@