Add template types

Requires: ReactiveX/RxPHP#218

Author: WyriHaximus

composer.json

@@ -12,7 +12,8 @@
     "php": "^8.4",
     "react/async": "^4.3.0",
     "react/promise": "^2.10 || ^3.3.0",
-    "reactivex/rxphp": "^2.1.0"
+    "reactivex/rxphp": "^2.1.0",
+    "wyrihaximus/react-event-loop-rx-scheduler-hook-up": "^0.1.1"
   },
   "require-dev": {
     "wyrihaximus/async-test-utilities": "^12.0.0",

composer.lock

@@ -13,18 +13,27 @@
 
 use function React\Async\await;
 
+/**
+ * @template T
+ * @template-implements Iterator<T>
+ */
 final class AwaitingIterator implements Iterator
 {
+    /** @var SplQueue<T> */
     private readonly SplQueue $queue;
     private readonly DisposableInterface $disposable;
+
+    /** @var Deferred<bool>|null */
     private Deferred|null $valid = null;
     private bool $completed      = false;
     private int $key             = 0;
 
+    /** @param ObservableInterface<T> $observable */
     public function __construct(ObservableInterface $observable)
     {
         $this->queue      = new SplQueue();
         $this->disposable = $observable->subscribe(
+            /** @param T $value */
             function (mixed $value): void {
                     $this->push($value);
             },
@@ -43,6 +52,7 @@ public function break(): void
         $this->completed = true;
     }
 
+    /** @param T $value */
     private function push(mixed $value): void
     {
         $this->queue->enqueue($value);
@@ -69,7 +79,7 @@ private function complete(): void
 
     // phpcs:disable
     /**
-     * @return mixed
+     * @return T
      */
     public function current(): mixed
     {
@@ -99,7 +109,10 @@ public function valid(): bool
         }
 
         if (! $this->completed) {
-            $this->valid = new Deferred();
+            /** @var Deferred<bool> $deferred */
+            $deferred    = new Deferred();
+            $this->valid = $deferred;
+            unset($deferred);
 
             return await($this->valid->promise());
         }

src/AwaitingIterator.php

@@ -6,7 +6,13 @@
 
 use Rx\Observable;
 
-/** @return iterable<mixed> */
+/**
+ * @param Observable<T> $observable
+ *
+ * @return iterable<T>
+ *
+ * @template T
+ */
 function awaitObservable(Observable $observable): iterable
 {
     return new AwaitingIterator($observable);

src/functions.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rx\Observable;
+
+use function PHPStan\Testing\assertType;
+use function WyriHaximus\React\awaitObservable;
+
+assertType('iterable<bool>', awaitObservable(Observable::fromArray([true, false])));
+assertType('iterable<int>', awaitObservable(Observable::fromArray([time()])));
+assertType('iterable<bool|int>', awaitObservable(Observable::fromArray([true, false, time()])));