<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <rodolfo@chevere.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Chevere\Parameter\Interfaces;

use IteratorAggregate;

/**
 * Describes the component in charge of defining a parameter of type iterable.
 *
 * @extends IteratorAggregate<ParameterInterface>
 */
interface IterableParameterInterface extends ParameterInterface, ParametersAccessInterface, IteratorAggregate
{
    /**
     * Asserts the given `$value` is valid.
     * @phpstan-ignore-next-line
     */
    public function __invoke(iterable $value): iterable;

    public function key(): ParameterInterface;

    public function value(): ParameterInterface;

    public function assertCompatible(self $parameter): void;

    /**
     * @param iterable<mixed, mixed> $default
     */
    public function withDefault(iterable $default): self;

    /**
     * @return iterable<mixed, mixed>
     */
    public function default(): ?iterable;

    public function typeSchema(): string;

    public function isList(): bool;

    public function isMap(): bool;
}