24 lines
1.0 KiB
JavaScript
24 lines
1.0 KiB
JavaScript
const require_kebabCase = require("../../string/kebabCase.js");
|
|
const require_deburr = require("./deburr.js");
|
|
const require_normalizeForCase = require("../_internal/normalizeForCase.js");
|
|
//#region src/compat/string/kebabCase.ts
|
|
/**
|
|
* Converts a string to kebab case.
|
|
*
|
|
* Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
|
|
*
|
|
* @param {string | object} str - The string that is to be changed to kebab case.
|
|
* @returns {string} - The converted string to kebab case.
|
|
*
|
|
* @example
|
|
* const convertedStr1 = kebabCase('camelCase') // returns 'camel-case'
|
|
* const convertedStr2 = kebabCase('some whitespace') // returns 'some-whitespace'
|
|
* const convertedStr3 = kebabCase('hyphen-text') // returns 'hyphen-text'
|
|
* const convertedStr4 = kebabCase('HTTPRequest') // returns 'http-request'
|
|
*/
|
|
function kebabCase(str) {
|
|
return require_kebabCase.kebabCase(require_normalizeForCase.normalizeForCase(require_deburr.deburr(str)));
|
|
}
|
|
//#endregion
|
|
exports.kebabCase = kebabCase;
|