1: <?php
2:
3: declare(strict_types=1);
4:
5: /**
6: * This file is part of the Nexus framework.
7: *
8: * (c) John Paul E. Balandan, CPA <paulbalandan@gmail.com>
9: *
10: * For the full copyright and license information, please view
11: * the LICENSE file that was distributed with this source code.
12: */
13:
14: namespace Nexus\Collection\Operation;
15:
16: use Nexus\Collection\CollectionInterface;
17:
18: /**
19: * @template T
20: */
21: interface Chunk
22: {
23: /**
24: * Returns a new collection containing the original items in the
25: * collection split into chunks of given `$size`.
26: *
27: * If the original collection does not split evenly,
28: * the final chunk will be smaller.
29: *
30: * @param int<1, max> $size
31: *
32: * @return CollectionInterface<int, non-empty-list<T>>
33: */
34: public function chunk(int $size): CollectionInterface;
35: }
36: