@technobuddha/library/src/collapse-breaking-space.ts

A large library of useful functions

import { clean } from './clean.ts';
import { space } from './unicode.ts';

/**
 * Options for the {@link collapseBreakingSpace} function
 * @group String
 * @category Operations
 */
export type CollapseBreakingSpaceOptions = {
  /** If true, trim leading and trailing whitespace */
  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
 * @group String
 * @category Operations
 */
export function collapseBreakingSpace(
  input: string,
  { trim = true }: CollapseBreakingSpaceOptions = {},
): string {
  const result = input.replaceAll(/[\t\r\n ]+/gu, space);
  return trim ? clean(result, '\t\r\n ') : result;
}