snakeCase

string

Converts string to snake case.

Installation

Import

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

Source Code

Implementation

/**
 * Converts string to snake case.
 *
 * @param string - The string to convert.
 * @returns Returns the snake cased string.
 *
 * @example
 * ```ts
 * snakeCase('Foo Bar'); // 'foo_bar'
 * snakeCase('fooBar'); // 'foo_bar'
 * snakeCase('--FOO-BAR--'); // 'foo_bar'
 * ```
 */
export function snakeCase(string: string): string {
  return string
    .replace(/[\s_-]+/g, ' ')
    .replace(/[A-Z]+/g, (match) => ` ${match.toLowerCase()}`)
    .trim()
    .replace(/\s+/g, '_')
    .toLowerCase();
}

Example

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

snakeCase('Foo Bar'); // 'foo_bar'
snakeCase('fooBar'); // 'foo_bar'
snakeCase('--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.