Chore: Add types to iterable_filter() (#30)

simPod · web-flow · commit a11bac0c963c · 2021-02-11T09:34:14.000+01:00
diff --git a/src/iterable-functions.php b/src/iterable-functions.php
@@ -75,9 +75,14 @@ function iterable_to_traversable(iterable $iterable): Traversable
 /**
  * Filters an iterable.
  *
- * @param iterable<mixed> $iterable
+ * @param (callable(TValue):bool)|null $filter
  *
- * @return iterable<mixed>
+ * @psalm-param iterable<TKey, TValue> $iterable
+ * @phpstan-param iterable<array-key, TValue> $iterable https://github.com/phpstan/phpstan/issues/4498
+ * @psalm-return iterable<TKey, TValue>
+ * @phpstan-return iterable<array-key, TValue> https://github.com/phpstan/phpstan/issues/4498
+ * @template TKey
+ * @template TValue
  */
 function iterable_filter(iterable $iterable, ?callable $filter = null): iterable
 {

Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,14 @@ function iterable_to_traversable(iterable $iterable): Traversable`
`75`	`75`	`/**`
`76`	`76`	`* Filters an iterable.`
`77`	`77`	`*`
`78`		`- * @param iterable<mixed> $iterable`
	`78`	`+ * @param (callable(TValue):bool)\|null $filter`
`79`	`79`	`*`
`80`		`- * @return iterable<mixed>`
	`80`	`+ * @psalm-param iterable<TKey, TValue> $iterable`
	`81`	`+ * @phpstan-param iterable<array-key, TValue> $iterable https://github.com/phpstan/phpstan/issues/4498`
	`82`	`+ * @psalm-return iterable<TKey, TValue>`
	`83`	`+ * @phpstan-return iterable<array-key, TValue> https://github.com/phpstan/phpstan/issues/4498`
	`84`	`+ * @template TKey`
	`85`	`+ * @template TValue`
`81`	`86`	`*/`
`82`	`87`	`function iterable_filter(iterable $iterable, ?callable $filter = null): iterable`
`83`	`88`	`{`