@technobuddha/library/dist/split-words.d.ts

A large library of useful functions

/**
 * Options for the {@link splitWords} function
 * @group String
 * @category Deconstruction
 */
export type SplitWordsOptions = {
    /** The delimiter between words */
    delimiter?: string | RegExp;
};
/**
 * Split a string into an array of words
 * @param input - The string to split
 * @param options - see {@link SplitWordsOptions}
 * @defaultValue delimiter whitespace
 * @returns array of words
 * @group String
 * @category Deconstruction
 */
export declare function splitWords(input: string, { delimiter }?: SplitWordsOptions): string[];