docs: Update typing information.

loophp · Dec 20, 2020 · a1d636f · a1d636f
1 parent 17eac77
commit a1d636f
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 14 deletions.
diff --git a/src/Iterator/MultipleIterableIterator.php b/src/Iterator/MultipleIterableIterator.php
@@ -18,7 +18,7 @@
 final class MultipleIterableIterator extends ProxyIterator
 {
     /**
-     * @psalm-param iterable<TKey, T> $iterable
+     * @psalm-param iterable<TKey, T> $iterators
      */
     public function __construct(iterable ...$iterators)
     {

diff --git a/src/Operation/Append.php b/src/Operation/Append.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Operation;
 
 use Closure;
-use Generator;
 use Iterator;
 use loophp\collection\Iterator\MultipleIterableIterator;
 
@@ -17,21 +16,21 @@
 final class Append extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Generator<int|TKey, T>
+     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Iterator<int|TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param T ...$items
              *
-             * @psalm-return Closure(Iterator<TKey, T>): Generator<int|TKey, T>
+             * @psalm-return Closure(Iterator<TKey, T>): Iterator<int|TKey, T>
              */
             static fn (...$items): Closure =>
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<int|TKey, T>
+                 * @psalm-return Iterator<int|TKey, T>
                  */
                 static function (Iterator $iterator) use ($items): Iterator {
                     return new MultipleIterableIterator($iterator, $items);

diff --git a/src/Operation/Filter.php b/src/Operation/Filter.php
@@ -31,7 +31,7 @@ public function __invoke(): Closure
              */
             static fn (callable ...$callbacks): Closure =>
                 /**
-                 * @psalm-param Iterator<TKey, T>
+                 * @psalm-param Iterator<TKey, T> $iterator
                  *
                  * @psalm-return Generator<TKey, T>
                  */

diff --git a/src/Operation/Map.php b/src/Operation/Map.php
@@ -45,7 +45,7 @@ static function (Iterator $iterator) use ($callbacks): Generator {
                             /**
                              * @param mixed $carry
                              * @psalm-param T $carry
-                             * @psalm-param callable(T, TKey): T $callback
+                             * @psalm-param callable(T, TKey, Iterator<TKey, T>): T $callback
                              *
                              * @psalm-return T
                              */

diff --git a/src/Operation/Merge.php b/src/Operation/Merge.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Operation;
 
 use Closure;
-use Generator;
 use Iterator;
 use loophp\collection\Iterator\MultipleIterableIterator;
 
@@ -17,7 +16,7 @@
 final class Merge extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(iterable<TKey, T>...): Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(iterable<TKey, T>...): Closure(Iterator<TKey, T>): Iterator<TKey, T>
      */
     public function __invoke(): Closure
     {
@@ -29,7 +28,7 @@ public function __invoke(): Closure
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<TKey, T>
+                 * @psalm-return Iterator<TKey, T>
                  */
                 static function (Iterator $iterator) use ($sources): Iterator {
                     return new MultipleIterableIterator($iterator, ...$sources);

diff --git a/src/Operation/Prepend.php b/src/Operation/Prepend.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Operation;
 
 use Closure;
-use Generator;
 use Iterator;
 use loophp\collection\Iterator\MultipleIterableIterator;
 
@@ -17,21 +16,21 @@
 final class Prepend extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Generator<int|TKey, T>
+     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Iterator<int|TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param T ...$items
              *
-             * @psalm-return Closure(Iterator<TKey, T>): Generator<int|TKey, T>
+             * @psalm-return Closure(Iterator<TKey, T>): Iterator<int|TKey, T>
              */
             static fn (...$items): Closure =>
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<int|TKey, T>
+                 * @psalm-return Iterator<int|TKey, T>
                  */
                 static function (Iterator $iterator) use ($items): Iterator {
                     return new MultipleIterableIterator($items, $iterator);