startCase

string

Converts string to start case.

Installation

Import

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

Source Code

Implementation

/**
 * Converts string to start case.
 *
 * @param string - The string to convert.
 * @returns Returns the start cased string.
 *
 * @example
 * ```ts
 * startCase('--foo-bar--'); // 'Foo Bar'
 * startCase('fooBar'); // 'Foo Bar'
 * startCase('__FOO_BAR__'); // 'FOO BAR'
 * ```
 */
export function startCase(string: string): string {
  return string
    .replace(/[\s_-]+/g, ' ')
    .replace(/[A-Z]+/g, (match) => ` ${match}`)
    .trim()
    .replace(/\s+(\w)/g, (_, char) => ` ${char.toUpperCase()}`)
    .replace(/^(\w)/, (char) => char.toUpperCase());
}

Example

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

startCase('--foo-bar--'); // 'Foo Bar'
startCase('fooBar'); // 'Foo Bar'
startCase('__FOO_BAR__'); // 'FOO BAR'

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.