lix-website/themes/lix/assets/bootstrap/node_modules/thenby/thenBy.module.d.ts
2024-04-26 22:49:34 -06:00

52 lines
2.6 KiB
TypeScript

// Type definitions for thenBy
// Definitions by: Teun Duynstee (with significant help from @HonoluluHenk)
type SortOrder = "asc" | "desc" | -1 | 1;
declare class opt {
direction?:SortOrder;
ignoreCase?:boolean;
}
declare class typedOpt<T> extends opt {
cmp?: (a:T, b:T)=> number;
}
interface IThenBy<T> {
(v1: T, v2: T) : number;
/**
* Full format to compare two elements and determine which sorts first.
* @param compare function that receives two values from the sorted array and returns a number indicating which comes first: < 0: first comes first, 0: doesn't matter, > 0: second comes first.
* @param direction can be used to reverse the sorting by passing -1
**/
thenBy<T>(compare: ((v1: T, v2: T) => number), direction?: SortOrder | opt): IThenBy<T>;
/**
* Shorthand for selecting a value to sort on from the sorted element.
* @param select function that receives a value from the sorted array and selects the thing to sort on
* @param direction reverse by passing -1. opt for other options
**/
thenBy<T, U>(select: ((v: T) => U), direction?: SortOrder | typedOpt<U>): IThenBy<T>;
/**
* Shorthand for sorting on a simple property.
* @param byPropertyName is the name of the property to sort on as a string
* @param direction reverse by passing -1. opt for other options
**/
thenBy<T>(byPropertyName: (keyof T), direction?: SortOrder | typedOpt<any>): IThenBy<T>;
}
declare module "thenby" {
/**
* Full format to compare two elements and determine which sorts first.
* @param compare function that receives two values from the sorted array and returns a number indicating which comes first: < 0: first comes first, 0: doesn't matter, > 0: second comes first.
* @param direction can be used to reverse the sorting by passing -1
**/
export function firstBy<T>(compare: ((v1: T, v2: T) => number), direction?: SortOrder | opt): IThenBy<T>;
/**
* Shorthand for selecting a value to sort on from the sorted element.
* @param select function that receives a value from the sorted array and selects the thing to sort on
* @param direction reverse by passing -1. opt for other options
**/
export function firstBy<T,U>(select: ((v: T) => U), direction?: SortOrder | typedOpt<U>): IThenBy<T>;
/**
* Shorthand for sorting on a simple property.
* @param byPropertyName is the name of the property to sort on as a string
* @param direction reverse by passing -1. opt for other options
**/
export function firstBy<T>(byPropertyName: (keyof T), direction?: SortOrder | typedOpt<any>): IThenBy<T>;
}