@technobuddha/library/collapseBreakingspace/collapseBreakingspace.ts

A large library of useful functions

import { space }                from '../constants';
import clean                    from '../clean';

export type Options = {
    /** If true, trim  */
    trim?: boolean;
};

/**
 * Replace all breaking space (space, tab, carriage return, new line) with a single space
 *
 * @param input The string
 * @param trim  If true, remove leading and trailing whitespace
 */
export function collapseBreakingspace(input: string, { trim = true }: Options = {}): string {
    if(trim)
        return clean(input.replace(/[\t\r\n ]+/ug, space), '\t\r\n ');
    return input.replace(/[\t\r\n ]+/ug, space);
}

export default collapseBreakingspace;