Merge pull request #27 from Ndiritu/Radiergummi/add-generic-annotations

Refactor Promise classes with generic types (fast-tracking #24)

Author: dbu

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+### Added
+
+- Generic annotations
+
 ## 1.1.0 - 2020-07-07
 
 ### Added

src/FulfilledPromise.php

@@ -6,14 +6,21 @@
  * A promise already fulfilled.
  *
  * @author Joel Wurtz <[email protected]>
+ *
+ * @template-covariant T
+ *
+ * @implements Promise<T>
  */
 final class FulfilledPromise implements Promise
 {
     /**
-     * @var mixed
+     * @var T
      */
     private $result;
 
+    /**
+     * @param T $result
+     */
     public function __construct($result)
     {
         $this->result = $result;

src/Promise.php

@@ -12,6 +12,8 @@
  *
  * @author Joel Wurtz <[email protected]>
  * @author Márk Sági-Kazár <[email protected]>
+ *
+ * @template-covariant T
  */
 interface Promise
 {
@@ -36,10 +38,12 @@ interface Promise
      * If you do not care about one of the cases, you can set the corresponding callable to null
      * The callback will be called when the value arrived and never more than once.
      *
-     * @param callable|null $onFulfilled called when a response will be available
-     * @param callable|null $onRejected  called when an exception occurs
+     * @param callable(T): V|null          $onFulfilled called when a response will be available
+     * @param callable(\Exception): V|null $onRejected  called when an exception occurs
+     *
+     * @return Promise<V> a new resolved promise with value of the executed callback (onFulfilled / onRejected)
      *
-     * @return Promise a new resolved promise with value of the executed callback (onFulfilled / onRejected)
+     * @template V
      */
     public function then(callable $onFulfilled = null, callable $onRejected = null);
 
@@ -61,7 +65,7 @@ public function getState();
      *
      * @param bool $unwrap Whether to return resolved value / throw reason or not
      *
-     * @return mixed Resolved value, null if $unwrap is set to false
+     * @return T Resolved value, null if $unwrap is set to false
      *
      * @throws \Exception the rejection reason if $unwrap is set to true and the request failed
      */

src/RejectedPromise.php

@@ -6,6 +6,10 @@
  * A rejected promise.
  *
  * @author Joel Wurtz <[email protected]>
+ *
+ * @template-covariant T
+ *
+ * @implements Promise<T>
  */
 final class RejectedPromise implements Promise
 {