@mikezimm/fps-core-v7/lib/logic/Strings/getWordsFromString.d.ts

Library of reusable core interfaces, types and constants migrated from fps-library-v2

import { ISeriesSort } from "../../logic/Arrays/sorting/Interfaces";
/**
 *
 * Originally used in Compliance to get list of words from a string
 * Updated 2023-03-28
 *
 * @param str
 * @param removeDigits
 * @returns array of words found
 */
export declare function mergeArrayOfWordsFromString(str: string, intoThese: string[], removeDigits: boolean, removeDups: boolean, ignoreCase: boolean, order: ISeriesSort, localLanguage?: string): string[];
/**
 * getArrayOfWordsFromString is a more advanced variation of getStringArrayBasic
 * This will check for duplicates and also allow for using or ignoring case.
 * Finally it also provides a built in option to sort.
 *
 * You can use getStringArrayBasic if you do not need any of those advanced options but to just split into words.
 * @param str
 * @param removeDigits
 * @param removeDups
 * @param ignoreCase
 * @param order
 * @param localLanguage
 * @returns
 */
export declare function getArrayOfWordsFromString(str: string, removeDigits: boolean, removeDups: boolean, ignoreCase: boolean, order: ISeriesSort, localLanguage?: string): string[];
export declare function mergeWordArrays(mergeThese: string[], intoThese: string[], ignoreCase: boolean, order: ISeriesSort, localLanguage?: string): string[];
//# sourceMappingURL=getWordsFromString.d.ts.map