@technobuddha/library/compareStrings/compareStrings.d.ts

A large library of useful functions

declare type Options = {
    /** if true, strings are to be compared case insensitive */
    caseInsensitive?: boolean;
    /** if true, compare numeric portions of the string as numbers */
    natural?: boolean;
    /** if true, compare strings as version numbers */
    version?: boolean;
};
/**
 * Compare two strings
 *
 * @param a First string
 * @param b Second string
 * @param caseInsensitive True if strings are to be compared case insensitive (default false)
 * @returns 0 if a == b; -1 if a < b; 1 if a > b
 *
 * @default caseInsensitive false
 * @default natural false
 * @default version false
 */
export declare function compareStrings(text1: string | null, text2: string | null, { caseInsensitive, natural, version }?: Options): (-1 | 0 | 1);
export default compareStrings;