Merge pull request #57 from simPod/generic-interface

Make PromiseInterface generic so it allows typing Promises
overblog · Nov 22, 2021 · 9181113 · 9181113
2 parents 56ca285 + 544408d
commit 9181113
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/lib/promise-adapter/src/Adapter/GuzzleHttpPromiseAdapter.php b/lib/promise-adapter/src/Adapter/GuzzleHttpPromiseAdapter.php
@@ -17,6 +17,9 @@
 use GuzzleHttp\Promise\RejectedPromise;
 use Overblog\PromiseAdapter\PromiseAdapterInterface;
 
+/**
+ * @implements PromiseAdapterInterface<PromiseInterface>
+ */
 class GuzzleHttpPromiseAdapter implements PromiseAdapterInterface
 {
     /**

diff --git a/lib/promise-adapter/src/Adapter/ReactPromiseAdapter.php b/lib/promise-adapter/src/Adapter/ReactPromiseAdapter.php
@@ -19,6 +19,9 @@
 use React\Promise\PromiseInterface;
 use React\Promise\RejectedPromise;
 
+/**
+ * @implements PromiseAdapterInterface<Promise>
+ */
 class ReactPromiseAdapter implements PromiseAdapterInterface
 {
     /**

diff --git a/lib/promise-adapter/src/Adapter/WebonyxGraphQLSyncPromiseAdapter.php b/lib/promise-adapter/src/Adapter/WebonyxGraphQLSyncPromiseAdapter.php
@@ -17,6 +17,9 @@
 use GraphQL\Executor\Promise\Promise;
 use Overblog\PromiseAdapter\PromiseAdapterInterface;
 
+/**
+ * @implements PromiseAdapterInterface<Promise>
+ */
 class WebonyxGraphQLSyncPromiseAdapter implements PromiseAdapterInterface
 {
     /** @var callable[] */

diff --git a/lib/promise-adapter/src/PromiseAdapterInterface.php b/lib/promise-adapter/src/PromiseAdapterInterface.php
@@ -11,6 +11,9 @@
 
 namespace Overblog\PromiseAdapter;
 
+/**
+ * @template TPromise
+ */
 interface PromiseAdapterInterface
 {
     /**
@@ -20,7 +23,7 @@ interface PromiseAdapterInterface
      * @param $reject
      * @param callable $canceller
      *
-     * @return mixed a Promise
+     * @return TPromise a Promise
      */
     public function create(&$resolve = null, &$reject = null, callable $canceller = null);
 
@@ -29,7 +32,7 @@ public function create(&$resolve = null, &$reject = null, callable $canceller =
      *
      * @param mixed $promiseOrValue
      *
-     * @return mixed a full filed Promise
+     * @return TPromise a full filed Promise
      */
     public function createFulfilled($promiseOrValue = null);
 
@@ -39,7 +42,7 @@ public function createFulfilled($promiseOrValue = null);
      *
      * @param mixed $reason
      *
-     * @return mixed a rejected promise
+     * @return TPromise a rejected promise
      */
     public function createRejected($reason);
 
@@ -49,7 +52,7 @@ public function createRejected($reason);
      *
      * @param mixed $promisesOrValues Promises or values.
      *
-     * @return mixed a Promise
+     * @return TPromise a Promise
      */
     public function createAll($promisesOrValues);
 
@@ -66,14 +69,14 @@ public function isPromise($value, $strict = false);
     /**
      * Cancel a promise
      *
-     * @param $promise
+     * @param TPromise $promise
      */
     public function cancel($promise);
 
     /**
      * wait for Promise to complete
-     * @param mixed $promise
-     * @param bool  $unwrap
+     * @param TPromise $promise
+     * @param bool     $unwrap
      *
      * @return mixed
      */