Skip to content

Commit

Permalink
docs: Update typing information.
Browse files Browse the repository at this point in the history
Signed-off-by: Pol Dellaiera <[email protected]>
  • Loading branch information
drupol committed Nov 15, 2020
1 parent cd260e2 commit 0ac6f71
Show file tree
Hide file tree
Showing 99 changed files with 104 additions and 99 deletions.
6 changes: 2 additions & 4 deletions src/Collection.php
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ public static function fromCallable(callable $callable, ...$parameters): self
{
return new self(
/**
* @psalm-param callable(T...) $data
* @psalm-param callable(T...) $callable
* @psalm-param list<T> $parameters
*
* @psalm-return Generator<TKey, T>
Expand All @@ -378,7 +378,7 @@ public static function fromIterable(iterable $iterable): self
{
return new self(
/**
* @psalm-param iterable<TKey, T> $data
* @psalm-param iterable<TKey, T> $iterable
*
* @psalm-return Generator<TKey, T>
*/
Expand All @@ -405,8 +405,6 @@ public static function fromString(string $string, string $delimiter = ''): self
{
return new self(
/**
* @psalm-param list<string> $parameters
*
* @psalm-return Generator<int, string>
*/
static fn (string $string, string $delimiter): Generator => yield from new StringIterator($string, $delimiter),
Expand Down
2 changes: 1 addition & 1 deletion src/Contract/Operation/Appendable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Appendable
*
* @param mixed ...$items
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function append(...$items): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Applyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Applyable
* @param callable ...$callables
* @psalm-param callable(TKey, T):bool ...$callables
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function apply(callable ...$callables): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Associateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface Associateable
* @psalm-param null|callable(TKey, T):TKey $callbackForKeys
* @psalm-param null|callable(TKey, T):T $callbackForValues
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function associate(?callable $callbackForKeys = null, ?callable $callbackForValues = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/AsyncMapable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface AsyncMapable
/**
* Asynchronously apply callbacks to a collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function asyncMap(callable ...$callbacks): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Cacheable.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
interface Cacheable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function cache(?CacheItemPoolInterface $cache = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Chunkable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Chunkable
/**
* Chunk the collection into chunks of the given size.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function chunk(int ...$sizes): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Collapseable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Collapseable
/**
* Collapse a collection of items into a simple flat collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function collapse(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Columnable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Columnable
*
* @param int|string $index
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function column($index): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Combinateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface Combinateable
* @param int $length
* The length.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function combinate(?int $length = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Combineable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Combineable
*
* @param mixed ...$keys
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function combine(...$keys): Collection;
}
3 changes: 2 additions & 1 deletion src/Contract/Operation/Compactable.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ interface Compactable
* Combine a collection of items with some other keys.
*
* @param mixed ...$values
* @psalm-param T ...$values
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function compact(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Containsable.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface Containsable
* @param mixed ...$value
* @psalm-param T ...$value
*
* @psalm-return \loophp\collection\Contract\Collection<int, bool>
* @psalm-return \loophp\collection\Collection<int, bool>
*/
public function contains(...$value): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Cycleable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Cycleable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function cycle(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Diffable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Diffable
/**
* @param mixed ...$values
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function diff(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Diffkeysable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Diffkeysable
/**
* @param mixed ...$values
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function diffKeys(...$values): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Distinctable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Distinctable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function distinct(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/DropWhileable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface DropWhileable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function dropWhile(callable ...$callbacks): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Dropable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Dropable
*
* @param int ...$counts
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function drop(int ...$counts): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Duplicateable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Duplicateable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function duplicate(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Everyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Everyable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, bool>
* @psalm-return \loophp\collection\Collection<TKey, bool>
*/
public function every(callable $callback): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Explodeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Explodeable
*
* @param mixed ...$explodes
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function explode(...$explodes): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Falsyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Falsyable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<int, bool>
* @psalm-return \loophp\collection\Collection<int, bool>
*/
public function falsy(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Filterable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Filterable
*
* @param callable ...$callbacks
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function filter(callable ...$callbacks): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Firstable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Firstable
/**
* Get the first item from the collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function first(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Flattenable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Flattenable
/**
* Flatten a collection of items into a simple flat collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function flatten(int $depth = PHP_INT_MAX): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Flipable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Flipable
/**
* Flip keys and items in a collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function flip(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/FoldLeft1able.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface FoldLeft1able
* @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
*
* @return mixed
* @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
* @psalm-return \loophp\collection\Collection<TKey, T|null>
*/
public function foldLeft1(callable $callback): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/FoldLeftable.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ interface FoldLeftable
* @psalm-param T|null $initial
*
* @return mixed
* @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
* @psalm-return \loophp\collection\Collection<TKey, T|null>
*/
public function foldLeft(callable $callback, $initial = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/FoldRight1able.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface FoldRight1able
* @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
*
* @return mixed
* @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
* @psalm-return \loophp\collection\Collection<TKey, T|null>
*/
public function foldRight1(callable $callback): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/FoldRightable.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ interface FoldRightable
* @psalm-param T|null $initial
*
* @return mixed
* @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
* @psalm-return \loophp\collection\Collection<TKey, T|null>
*/
public function foldRight(callable $callback, $initial = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Forgetable.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ interface Forgetable
*
* @param mixed ...$keys
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function forget(...$keys): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Frequencyable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Frequencyable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function frequency(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Getable.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ interface Getable
* @param mixed $default
* @psalm-param T|null $default
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
* @psalm-return \loophp\collection\Collection<TKey, T|null>
*/
public function get($key, $default = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/GroupByable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface GroupByable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function groupBy(?callable $callback = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Groupable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Groupable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function group(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Hasable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Hasable
/**
* @psalm-param callable(TKey, T): bool $callback
*
* @psalm-return \loophp\collection\Contract\Collection<int, bool>
* @psalm-return \loophp\collection\Collection<int, bool>
*/
public function has(callable $callback): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Headable.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface Headable
/**
* Get the first item from the collection.
*
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function head(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/IfThenElseable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface IfThenElseable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function ifThenElse(callable $condition, callable $then, ?callable $else = null): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Implodeable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Implodeable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<int, string>
* @psalm-return \loophp\collection\Collection<int, string>
*/
public function implode(string $glue = ''): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Initable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Initable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function init(): Collection;
}
2 changes: 1 addition & 1 deletion src/Contract/Operation/Initsable.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
interface Initsable
{
/**
* @psalm-return \loophp\collection\Contract\Collection<TKey, T>
* @psalm-return \loophp\collection\Collection<TKey, T>
*/
public function inits(): Collection;
}
Loading

0 comments on commit 0ac6f71

Please sign in to comment.