@codibre/fluent-iterable/dist/types/function-types/avg-function.d.ts

Provides LINQ-like fluent api operations for iterables and async iterables (ES2018+).

import { AsyncMapper, Mapper } from 'augmentative-iterable';
export interface AvgFunction<T> {
    /**
     * Calculates the average of the elements of the iterable projected into a `number`. This is a resolving operation, will cause a full loop through all the elements of the iterable.<br>
     *   Examples:<br>
     *     * `fluent([5, -2, 9]).avg()` returns *4*
     *     * `fluent(['anchor', 'almond', 'bound', 'alpine']).avg(word => word.length)` returns *5.75*, the average of the length of all the words in the iterable
     * @param mapper The function which projects the elements of the iterable into `number`s. Falls back to the identity function if omitted.
     * @returns The average of the projected elements of the iterable.
     */
    (mapper?: Mapper<T, number>): number;
    /**
     * Calculates the average of the elements of the iterable projected into a `number`. This is a resolving operation, will cause a full loop through all the elements of the iterable.<br>
     *   Examples:<br>
     *     * `fluent([5, -2, 9]).avg()` returns *4*
     *     * `fluent(['anchor', 'almond', 'bound', 'alpine']).avg(word => word.length)` returns *5.75*, the average of the length of all the words in the iterable
     * @param mapper The function which projects the elements of the iterable into `number`s. Falls back to the identity function if omitted.
     * @returns The average of the projected elements of the iterable.
     */
    (mapper: keyof T): number;
}
export interface AsyncAvgFunction<T> {
    /**
     * Calculates the average of the elements of the iterable asynchronously projected into a `number`. This is a resolving operation, will cause a full loop through all the elements of the iterable.
     * @param mapper The asynchronous function which projects the elements of the iterable into `number`s. Falls back to the identity function if omitted.
     * @returns A promise of the average of the projected elements of the iterable.
     */
    (mapper?: AsyncMapper<T, number>): Promise<number>;
    /**
     * Calculates the average of the elements of the iterable asynchronously projected into a `number`. This is a resolving operation, will cause a full loop through all the elements of the iterable.
     * @param mapper The asynchronous function which projects the elements of the iterable into `number`s. Falls back to the identity function if omitted.
     * @returns A promise of the average of the projected elements of the iterable.
     */
    (mapper: keyof T): Promise<number>;
}