trim

string

Removes leading and trailing whitespace or specified characters from string.

Installation

Import

import { trim } from '@tulx/utils';

Source Code

Implementation

/**
 * Removes leading and trailing whitespace or specified characters from string.
 *
 * @param string - The string to trim.
 * @param chars - The characters to trim.
 * @returns Returns the trimmed string.
 *
 * @example
 * ```ts
 * trim('  abc  '); // 'abc'
 * trim('-_-abc-_-', '_-'); // 'abc'
 * ```
 */
function escapeRegExpForTrim(chars: string): string {
  return chars.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
}

export function trim(string: string, chars?: string): string {
  if (chars === undefined) {
    return string.trim();
  }

  const pattern = `[${escapeRegExpForTrim(chars)}]+`;
  return string.replace(new RegExp(`^${pattern}|${pattern}$`, 'g'), '');
}

Example

import { trim } from '@tulx/utils';

trim('  abc  '); // 'abc'
trim('-_-abc-_-', '_-'); // 'abc'

Related Functions

camelCase

Converts string to camel case.

capitalize

Converts the first character of string to upper case and the remaining to lower case.

deburr

Deburrs string by converting Latin-1 Supplement and Latin Extended-A letters to basic Latin letters and removing combining diacritical marks.

endsWith

Checks if string ends with the given target string.

escape

Converts the characters "&", "<", ">", '"', and "'" in string to their corresponding HTML entities.

escapeRegExp

Escapes the RegExp special characters "^", "$", "\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in string.