Chore: Add types to iterable_to_array() (#27)

simPod · web-flow · commit 8d61a26fbc9e · 2021-02-11T09:12:31.000+01:00
diff --git a/src/iterable-functions.php b/src/iterable-functions.php
@@ -27,12 +27,17 @@ function iterable_map(iterable $iterable, callable $map): iterable
 }
 
 /**
- * Copy the iterable into an array. If the iterable is already an array, return it.
+ * Copy the iterable into an array.
  *
- * @param iterable<mixed> $iterable
+ * @param iterable<array-key, TValue> $iterable
  * @param bool $preserveKeys [optional] Whether to use the iterator element keys as index.
  *
- * @return array<mixed>
+ * @return array<array-key, TValue>
+ *
+ * @psalm-return ($preserveKeys is true ? array<TKey, TValue> : array<int, TValue>)
+ * @psalm-template TKey as array-key
+ * @phpstan-template TKey
+ * @template TValue
  */
 function iterable_to_array(iterable $iterable, bool $preserveKeys = true): array
 {

Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,17 @@ function iterable_map(iterable $iterable, callable $map): iterable`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Copy the iterable into an array. If the iterable is already an array, return it.`
	`30`	`+ * Copy the iterable into an array.`
`31`	`31`	`*`
`32`		`- * @param iterable<mixed> $iterable`
	`32`	`+ * @param iterable<array-key, TValue> $iterable`
`33`	`33`	`* @param bool $preserveKeys [optional] Whether to use the iterator element keys as index.`
`34`	`34`	`*`
`35`		`- * @return array<mixed>`
	`35`	`+ * @return array<array-key, TValue>`
	`36`	`+ *`
	`37`	`+ * @psalm-return ($preserveKeys is true ? array<TKey, TValue> : array<int, TValue>)`
	`38`	`+ * @psalm-template TKey as array-key`
	`39`	`+ * @phpstan-template TKey`
	`40`	`+ * @template TValue`
`36`	`41`	`*/`
`37`	`42`	`function iterable_to_array(iterable $iterable, bool $preserveKeys = true): array`
`38`	`43`	`{`