loophp / collection

src/Contract/Operation/Pluckable.php

<?php

declare(strict_types=1);

namespace loophp\collection\Contract\Operation;

use loophp\collection\Contract\Collection;

/**
 * @template TKey
 * @template T
 */
interface Pluckable
{
    /**
     * Retrieves all of the values of a collection for a given key.
     * Nested values can be retrieved using “dot notation” and the wildcard character `*`.
     *
     * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#pluck
     *
     * @param array<int, string>|array-key $pluck

The doc comment array<int, string>|array-key at position 7 could not be parsed: Unknown type name 'array-key' at position 7 in array<int, string>|array-key.

     *
     * @return Collection<int, iterable<int, T>|T>
     */
    public function pluck(mixed $pluck, mixed $default = null): Collection;
}