@gobstones/gobstones-core/src/Expectations/Interfaces/ArrayExpectation.ts

A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.

/*
 * *****************************************************************************
 * Copyright (C) National University of Quilmes 2018-2024
 * Gobstones (TM) is a trademark of the National University of Quilmes.
 *
 * This program is free software distributed under the terms of the
 * GNU Affero General Public License version 3.
 * Additional terms added in compliance to section 7 of such license apply.
 *
 * You may read the full license at https://gobstones.github.io/gobstones-guidelines/LICENSE.
 * *****************************************************************************
 */

/**
 * @module Expectations/Interfaces
 * @author Alan Rodas Bonjour <alanrodas@gmail.com>
 */

import { Expectation } from './Expectation';
import { FinishedExpectation } from './FinishedExpectation';

/**
 * This interface represents an expectation that is performed over an array.
 *
 * @group API: Types
 */
export interface ArrayExpectation<T> extends Expectation<T[]> {
    /**
     * Answer if the actual value is empty.
     */
    toBeEmptyArray(): this & FinishedExpectation;
    /**
     * Answer if the actual value has a length of expected number.
     */
    toHaveLength(count: number): this & FinishedExpectation;
    /**
     * Answer if the actual value contains the expected element.
     */
    toContain(value: T): this & FinishedExpectation;
    /**
     * Answer if the actual value has a the expected element at a given position.
     * Returns false if the position does not exist.
     */
    toHaveAtPosition(value: T, position: number): this & FinishedExpectation;
    /**
     * Answer if all the element of the actual value satisfy a given criteria.
     */
    allToSatisfy(criteria: (item: T) => boolean): this & FinishedExpectation;
    /**
     * Answer if any of the element of the actual value satisfy a given criteria.
     */
    anyToSatisfy(criteria: (item: T) => boolean): this & FinishedExpectation;
    /**
     * Answer if a given amount of elements of the actual value satisfy a given criteria.
     */
    amountToSatisfy(count: number, criteria: (item: T) => boolean): this & FinishedExpectation;
}