More specific Chunkable::chunk() return type

[rela589n]

Currently Chunkable interface looks like this:

/**
 * @template TKey
 * @template T
 */
interface Chunkable
{
    /**
     * Chunk a collection of items into chunks of items of a given size.
     *
     * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#chunk
     *
     * @return Collection<int, list<T>>
     */
    public function chunk(int ...$sizes): Collection;
}

As you can see, this operation returns Collection<int, list<T>>, which is fair.

Yet, since after applying chunk(), each produced chunk can will never be empty list.

Therefore, maybe it would make sense to specify Collection<int, non-empty-list<T>> as a return type, since this is more specific.

[drupol]

Hello,

Yes! Nice catch.

Please submit a PR to fix this and I'll merge it.

[github-actions]

Since this issue has not had any activity within the last 5 days, I have marked it as stale.
I will close it if no further activity occurs within the next 5 days.

[github-actions]

Since this issue has not had any activity within the last 5 days, I have marked it as stale.
I will close it if no further activity occurs within the next 5 days.

[rela589n]

Closing as completed