Fix return type of sortBy and sortByDescending methods

MortalFlesh · Nov 25, 2023 · d620ae9 · d620ae9
1 parent 8bbbb9f
commit d620ae9
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 <!-- There is always Unreleased section on the top. Subsections (Add, Changed, Fix, Removed) should be Add as needed. -->
 ## Unreleased
+- Fix return type of `sortBy` and `sortByDescending` methods
 
 ## 8.1.0 - 2023-05-19
 - Add `Immutable\Generic\IList::choose` method

diff --git a/src/Immutable/Generic/IList.php b/src/Immutable/Generic/IList.php
@@ -122,13 +122,13 @@ public function sort(): IList;
     public function sortDescending(): IList;
 
     /**
-     * @phpstan-param callable(TValue, TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TValue): (string|int|float) $callback
      * @phpstan-return IList<TValue>
      */
     public function sortBy(callable $callback): IList;
 
     /**
-     * @phpstan-param callable(TValue, TIndex=): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TIndex=): (string|int|float) $callback
      * @phpstan-return IList<TValue>
      */
     public function sortByDescending(callable $callback): IList;

diff --git a/src/Immutable/Generic/ISeq.php b/src/Immutable/Generic/ISeq.php
@@ -226,15 +226,15 @@ public function sort(): ISeq;
     public function sortDescending(): ISeq;
 
     /**
-     * @phpstan-param callable(TValue, TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TValue): (string|int|float) $callback
      * @phpstan-return ISeq<TValue>
      *
      * @throws OutOfBoundsException
      */
     public function sortBy(callable $callback): ISeq;
 
     /**
-     * @phpstan-param callable(TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue): (string|int|float) $callback
      * @phpstan-return ISeq<TValue>
      *
      * @throws OutOfBoundsException

diff --git a/src/Immutable/Generic/ListCollection.php b/src/Immutable/Generic/ListCollection.php
@@ -364,7 +364,7 @@ public function sortDescending(): IList
     }
 
     /**
-     * @phpstan-param callable(TValue, TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TValue): (string|int|float) $callback
      * @phpstan-return IList<TValue>
      */
     public function sortBy(callable $callback): IList
@@ -381,7 +381,7 @@ public function sortBy(callable $callback): IList
     }
 
     /**
-     * @phpstan-param callable(TValue, TIndex=): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TIndex=): (string|int|float) $callback
      * @phpstan-return IList<TValue>
      */
     public function sortByDescending(callable $callback): IList

diff --git a/src/Immutable/Generic/Seq.php b/src/Immutable/Generic/Seq.php
@@ -670,7 +670,7 @@ public function sortDescending(): ISeq
     }
 
     /**
-     * @phpstan-param callable(TValue, TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue, TValue): (string|int|float) $callback
      * @phpstan-return ISeq<TValue>
      *
      * @throws OutOfBoundsException
@@ -695,7 +695,7 @@ public function sortBy(callable $callback): ISeq
     }
 
     /**
-     * @phpstan-param callable(TValue): int<-1, 1> $callback
+     * @phpstan-param callable(TValue): (string|int|float) $callback
      * @phpstan-return ISeq<TValue>
      *
      * @throws OutOfBoundsException

diff --git a/src/Mutable/Generic/IList.php b/src/Mutable/Generic/IList.php
@@ -94,10 +94,10 @@ public function sort(): void;
 
     public function sortDescending(): void;
 
-    /** @phpstan-param callable(TValue, TValue): int<-1, 1> $callback */
+    /** @phpstan-param callable(TValue, TValue): (string|int|float) $callback */
     public function sortBy(callable $callback): void;
 
-    /** @phpstan-param callable(TValue, TIndex=): int<-1, 1> $callback */
+    /** @phpstan-param callable(TValue, TIndex=): (string|int|float) $callback */
     public function sortByDescending(callable $callback): void;
 
     /** Keeps only unique values inside the list. */

diff --git a/src/Mutable/Generic/ListCollection.php b/src/Mutable/Generic/ListCollection.php
@@ -317,7 +317,7 @@ public function sortDescending(): void
         rsort($this->listArray);
     }
 
-    /** @phpstan-param callable(TValue, TValue): int<-1, 1> $callback */
+    /** @phpstan-param callable(TValue, TValue): (string|int|float) $callback */
     public function sortBy(callable $callback): void
     {
         $callback = Callback::curry($callback);
@@ -328,7 +328,7 @@ public function sortBy(callable $callback): void
         );
     }
 
-    /** @phpstan-param callable(TValue, TIndex=): int<-1, 1> $callback */
+    /** @phpstan-param callable(TValue, TIndex=): (string|int|float) $callback */
     public function sortByDescending(callable $callback): void
     {
         $callback = Callback::curry($callback);