docs: Update annotations.

Signed-off-by: Pol Dellaiera <pol.dellaiera@protonmail.com>
loophp · Oct 27, 2020 · 7386746 · 7386746
1 parent a080fae
commit 7386746
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/src/Contract/Operation/Pipeable.php b/src/Contract/Operation/Pipeable.php
@@ -5,6 +5,7 @@
 namespace loophp\collection\Contract\Operation;
 
 use Generator;
+use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -15,7 +16,7 @@
 interface Pipeable
 {
     /**
-     * @psalm-param callable(): Generator ...$callables
+     * @psalm-param callable(Iterator<TKey, T>): Generator<TKey, T> ...$callables
      *
      * @psalm-return \loophp\collection\Contract\Collection<TKey, T>
      */

diff --git a/src/Operation/Flatten.php b/src/Operation/Flatten.php
@@ -17,20 +17,20 @@
 final class Flatten extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(int): Closure(Iterator<TKey, T>): Generator<int, T>
+     * @psalm-return Closure(int): Closure(Iterator<TKey, T>): Generator<int|TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, T>
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int|TKey, T>
              */
             static function (int $depth): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
                      *
-                     * @psalm-return Generator<int, T>
+                     * @psalm-return Generator<int|TKey, T>
                      */
                     static function (Iterator $iterator) use ($depth): Generator {
                         foreach ($iterator as $key => $value) {
@@ -47,8 +47,10 @@ static function (Iterator $iterator) use ($depth): Generator {
                                 $value = $flatten(new IterableIterator($value));
                             }
 
-                            /** @psalm-var TKey $subKey */
-                            /** @psalm-var T $subValue */
+                            /**
+                             * @psalm-var TKey $subKey
+                             * @psalm-var T $subValue
+                             */
                             foreach ($value as $subKey => $subValue) {
                                 yield $subKey => $subValue;
                             }

diff --git a/src/Operation/Tails.php b/src/Operation/Tails.php
@@ -28,7 +28,7 @@ public function __invoke(): Closure
              * @psalm-return Generator<int, array<TKey, T>, mixed, void>
              */
             static function (Iterator $iterator): Generator {
-                /** @psalm-var Iterator<int, array{0: TKey, 1: T}>  */
+                /** @psalm-var Iterator<int, array{0: TKey, 1: T}> $iterator */
                 $iterator = Pack::of()($iterator);
                 $data = iterator_to_array($iterator);