diginext-utils/esm/array.d.ts

README.md

export declare const sumArray: (array: [], key: string) => number;
/**
 *
 * @param {Array} array
 * @param {string} key
 * @returns {Number}
 */
export declare const averageArray: (array: [], key: string) => number;
/**
 *
 * @param {Array} array
 * @param {string} key
 * @returns {Number}
 */
export declare const minArray: (array: [], key: string) => number;
/**
 *
 * @param {Array} array
 * @param {string} key
 * @returns {Number}
 */
export declare const maxArray: (array: [], key: string) => number;
/**
 *
 * @param {Array} array
 * @param {string} key
 * @returns {Array}
 */
export declare const sortElementByString: (array: any, key: string) => any[] | undefined;
/**
 *
 * @param {Array} array
 * @param {string} key
 * @returns {Array}
 */
export declare const sortElementByNumber: (array: any, key: string) => any[] | undefined;
/**
 *
 * @param {Array} array
 * @returns {any}
 */
export declare const firstElement: (array: any[]) => any;
/**
 *
 * @param {Array} array
 * @returns {any}
 */
export declare const lastElement: (array: any[]) => any;
/**
 *
 * @param {Array} array
 * @returns {any}
 */
export declare const randomIndex: (array: any[]) => number;
/**
 *
 * @param {Array} array
 * @returns {any}
 */
export declare const randomElement: (array: any[]) => any;
/**
 * Remove same elements from 2 arrays
 */
export declare const mergeAndMakeUniqueElement: (list1: any[], list2: any[], key: string) => any[] | undefined;
/**
 * check target == toMatch
 * @param {Array} target
 * @param {Array} toMatch
 * @returns {Boolean}
 */
export declare const allMatchInArray: (target: any[], toMatch: any[]) => boolean;
export declare const removeItem: (item: any, array: any[]) => any[];
export declare const removeItemByKey: (key: string, value: any, array: any[]) => any[];
export declare const getRandom: (array: any[], n?: number) => any[];
/**
 * Get an array with shuffle element
 */
export declare const getHalfRandom: (array: any[], n: number) => any[];
/**
 * Make array shuffle itself
 */
export declare const shuffle: (array: any[]) => any[];
/**
 *
 * @param {Array} array
 * @param {Number} oldIndex
 * @param {Number} newIndex
 * @returns {Array}
 */
export declare const moveIndex: (array: any[], oldIndex: number, newIndex: number) => any[];
export declare const moveArray: (array: any[], oldIndex: number, newIndex: number) => any[];
declare const xarray: {
    sumArray: (array: [], key: string) => number;
    averageArray: (array: [], key: string) => number;
    minArray: (array: [], key: string) => number;
    maxArray: (array: [], key: string) => number;
    sortElementByString: (array: any, key: string) => any[] | undefined;
    sortElementByNumber: (array: any, key: string) => any[] | undefined;
    firstElement: (array: any[]) => any;
    lastElement: (array: any[]) => any;
    randomIndex: (array: any[]) => number;
    randomElement: (array: any[]) => any;
    mergeAndMakeUniqueElement: (list1: any[], list2: any[], key: string) => any[] | undefined;
    allMatchInArray: (target: any[], toMatch: any[]) => boolean;
    removeItem: (item: any, array: any[]) => any[];
    removeItemByKey: (key: string, value: any, array: any[]) => any[];
    getRandom: (array: any[], n?: number) => any[];
    getHalfRandom: (array: any[], n: number) => any[];
    shuffle: (array: any[]) => any[];
    moveIndex: (array: any[], oldIndex: number, newIndex: number) => any[];
    moveArray: (array: any[], oldIndex: number, newIndex: number) => any[];
};
export default xarray;