si-funciona/dist/helpers/functions/relevancyFilter.d.ts

Funciones de utilidad para uso general. [General usage utility functions.]

import 'core-js/stable';
/**
 * An object having an integer valued property named 'relevance'.
 * @typedef {Object} relevanceObject
 * @memberOf module:functionHelpers
 * @property {Array|Object} source
 * @property {Array|Object} object
 * @property {number} relevance
 */
export type relevanceObject = {
    source: Array<any> | Object;
    object: Array<any> | Object;
    relevance: number;
};
/**
 * A map of relevanceObjects which can be manipulated to filter results.
 * @typedef {Array.<relevanceObject>} relevanceMap
 * @memberOf module:functionHelpers
 */
export type relevanceMap = Array<relevanceObject>;
type relevancyFilterOptions = {
    mapLimit?: number;
    relevancyRange?: number;
};
/**
 * Remove elements out of relevance range and update the max relevance.
 * @memberOf module:functionHelpers
 * @param {relevanceMap} map
 * @param {Object} [options={}]
 * @param {int} [options.mapLimit=1000]
 * @param {int} [options.relevancyRange=100]
 * @returns {relevanceMap}
 */
declare const relevancyFilter: (map: relevanceMap, { mapLimit, relevancyRange }?: relevancyFilterOptions) => relevanceMap;
export default relevancyFilter;