Merge pull request #40879 from zingimmick/fix-type-definition

[9.x] Improves `Support\Collection` each method type definition
laravel · Feb 9, 2022 · dfef6a1 · dfef6a1
2 parents ca33630 + 23a2675
commit dfef6a1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/Illuminate/Collections/Enumerable.php b/src/Illuminate/Collections/Enumerable.php
@@ -259,7 +259,7 @@ public function duplicatesStrict($callback = null);
     /**
      * Execute a callback over each item.
      *
-     * @param  callable(TValue): mixed  $callback
+     * @param  callable(TValue, TKey): mixed  $callback
      * @return $this
      */
     public function each(callable $callback);

diff --git a/src/Illuminate/Collections/Traits/EnumeratesValues.php b/src/Illuminate/Collections/Traits/EnumeratesValues.php
@@ -252,7 +252,7 @@ public function dump()
     /**
      * Execute a callback over each item.
      *
-     * @param  callable(TValue): mixed  $callback
+     * @param  callable(TValue, TKey): mixed  $callback
      * @return $this
      */
     public function each(callable $callback)

diff --git a/types/Support/Collection.php b/types/Support/Collection.php
@@ -189,6 +189,10 @@
 assertType('Illuminate\Support\Collection<int, User>', $collection->each(function ($user) {
     assertType('User', $user);
 }));
+assertType('Illuminate\Support\Collection<int, User>', $collection->each(function ($user, $int) {
+    assertType('int', $int);
+    assertType('User', $user);
+}));
 
 assertType('Illuminate\Support\Collection<int, array{string}>', $collection::make([['string']])
     ->eachSpread(function ($int, $string) {