Update and fix Psalm phpdoc.

loophp · Aug 4, 2020 · 91c8900 · 91c8900
1 parent a94f3ee
commit 91c8900
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/src/Operation/Flatten.php b/src/Operation/Flatten.php
@@ -38,10 +38,12 @@ static function (Iterator $iterator, int $depth): Generator {
                     if (false === is_iterable($value)) {
                         yield $value;
                     } elseif (1 === $depth) {
+                        /** @psalm-var T $subValue */
                         foreach ($value as $subValue) {
                             yield $subValue;
                         }
                     } elseif (is_array($value)) {
+                        /** @psalm-var T $subValue */
                         foreach ((new Run(new Flatten($depth - 1)))(new ArrayIterator($value)) as $subValue) {
                             yield $subValue;
                         }

diff --git a/src/Operation/Intersperse.php b/src/Operation/Intersperse.php
@@ -37,7 +37,9 @@ public function __construct($element, int $atEvery = 1, int $startAt = 0)
 
     public function __invoke(): Closure
     {
+        /** @var int $every */
         $every = $this->get('atEvery');
+        /** @var int $startAt */
         $startAt = $this->get('startAt');
 
         if (0 > $every) {
@@ -55,7 +57,7 @@ public function __invoke(): Closure
              * @param mixed $element
              * @psalm-param T $element
              *
-             * @psalm-return \Generator<int, T>
+             * @psalm-return \Generator<int|TKey, T>
              */
             static function (Iterator $iterator, $element, int $every, int $startAt): Generator {
                 foreach ($iterator as $key => $value) {

diff --git a/src/Operation/Pair.php b/src/Operation/Pair.php
@@ -26,6 +26,7 @@ public function __invoke(): Closure
              * @psalm-return \Generator<TKey, T>
              */
             static function (Iterator $iterator): Generator {
+                /** @psalm-var list<int, list<T|TKey>> $chunk */
                 foreach ((new Run(new Chunk(2)))($iterator) as $chunk) {
                     /** @psalm-var array{TKey, T} $chunk */
                     $chunk = array_values($chunk);

diff --git a/src/Operation/Reduction.php b/src/Operation/Reduction.php
@@ -34,16 +34,16 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param \Iterator<TKey, T> $iterator
-             * @psalm-param callable(T|null, T, TKey):(T|null) $callable
+             * @psalm-param callable(T|null, T, TKey):(T|null) $callback
              *
              * @param mixed $initial
              * @psalm-param T|null $initial
              *
-             * @psalm-return \Generator<int, T|null>
+             * @psalm-return \Generator<TKey, T|null>
              */
             static function (Iterator $iterator, callable $callback, $initial): Generator {
                 foreach ($iterator as $key => $value) {
-                    yield $initial = $callback($initial, $value, $key);
+                    yield $key => ($initial = $callback($initial, $value, $key));
                 }
             };
     }

diff --git a/src/Operation/Unpair.php b/src/Operation/Unpair.php
@@ -22,7 +22,7 @@ public function __invoke(): Closure
             /**
              * @psalm-param \Iterator<TKey, T> $iterator
              *
-             * @psalm-return \Generator<TKey, T>
+             * @psalm-return \Generator<int, array{TKey, T}>
              */
             static function (Iterator $iterator): Generator {
                 foreach ($iterator as $key => $value) {