stringcase.d.lua

---@meta _

---
---String case conversion and word splitting.
---
---## Usage
---
---```lua
---stringcase = mods.stringcase
---
---print(stringcase.snake("FooBar")) --> "foo_bar"
---```
---@class mods.stringcase
local M = {}

---
---Convert string to all lowercase.
---
---```lua
---lower("foo_bar-baz") --> "foo_bar-baz"
---lower("FooBar baz")  --> "foobar baz"
---```
---
---@section Basic
---@param s string Input string.
---@return string lowercased Lowercased string.
---@nodiscard
function M.lower(s) end

---
---Convert string to all uppercase.
---
---```lua
---upper("foo_bar-baz") --> "FOO_BAR-BAZ"
---upper("FooBar baz")  --> "FOOBAR BAZ"
---```
---
---@section Basic
---@param s string Input string.
---@return string uppercased Uppercased string.
---@nodiscard
function M.upper(s) end

---
---Convert string to snake_case.
---
---```lua
---snake("foo_bar-baz") --> "foo_bar_baz"
---snake("FooBar baz")  --> "foo_bar_baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string snakeCased Snake-cased string.
---@nodiscard
function M.snake(s) end

---
---Convert string to camelCase.
---
---```lua
---camel("foo_bar-baz") --> "fooBarBaz"
---camel("FooBar baz")  --> "fooBarBaz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string camelCased Camel-cased string.
---@nodiscard
function M.camel(s) end

---
---Normalize to snake_case, then delimit words with a separator.
---
---```lua
---delimit("foo_bar-baz", "-") --> "foo-bar-baz"
---delimit("FooBar baz", "-")  --> "foo-bar-baz"
---```
---
---@section Word Case
---@param s string Input string.
---@param sep? string Optional separator value (defaults to `""`).
---@return string delimited String with normalized words separated by `sep`.
---@nodiscard
function M.delimit(s, sep) end

---
---Get acronym of words in string (first letters only).
---
---```lua
---acronym("foo_bar-baz") --> "FBB"
---acronym("FooBar baz")  --> "FBB"
---```
---
---@section Word Case
---@param s string Input string.
---@return string acronym Acronym string.
---@nodiscard
function M.acronym(s) end

---
---Convert string to Title Case (first letter of each word capitalized).
---
---```lua
---title("foo_bar-baz") --> "Foo Bar Baz"
---title("FooBar baz")  --> "Foo Bar Baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string titleCased Title-cased string.
---@nodiscard
function M.title(s) end

---
---Convert string to CONSTANT_CASE (uppercase snake_case).
---
---```lua
---constant("foo_bar-baz") --> "FOO_BAR_BAZ"
---constant("FooBar baz")  --> "FOO_BAR_BAZ"
---```
---
---@section Word Case
---@param s string Input string.
---@return string constantCased Constant-cased string.
---@nodiscard
function M.constant(s) end

---
---Convert string to PascalCase.
---
---```lua
---pascal("foo_bar-baz") --> "FooBarBaz"
---pascal("FooBar baz")  --> "FooBarBaz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string pascalCased Pascal-cased string.
---@nodiscard
function M.pascal(s) end

---
---Convert string to kebab-case.
---
---```lua
---kebab("foo_bar-baz") --> "foo-bar-baz"
---kebab("FooBar baz")  --> "foo-bar-baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string kebabCased Kebab-cased string.
---@nodiscard
function M.kebab(s) end

---
---Convert string to dot.case.
---
---```lua
---dot("foo_bar-baz") --> "foo.bar.baz"
---dot("FooBar baz")  --> "foo.bar.baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string dotCased Dot-cased string.
---@nodiscard
function M.dot(s) end

---
---Convert string to space case (spaces between words).
---
---```lua
---space("foo_bar-baz") --> "foo bar baz"
---space("FooBar baz")  --> "foo bar baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string spaceCased Space-cased string.
---@nodiscard
function M.space(s) end

---
---Convert string to path/case (slashes between words).
---
---```lua
---path("foo_bar-baz") --> "foo/bar/baz"
---path("FooBar baz")  --> "foo/bar/baz"
---```
---
---@section Word Case
---@param s string Input string.
---@return string pathCased Path-cased string.
---@nodiscard
function M.path(s) end

---
---Swap case of each letter.
---
---```lua
---swapcase("foo_bar-baz") --> "FOO_BAR-BAZ"
---swapcase("FooBar baz")  --> "fOObAR BAZ"
---```
---
---@section Letter Case
---@param s string Input string.
---@return string swapCased Swap-cased string.
---@nodiscard
function M.swapcase(s) end

---
---Capitalize the first letter and lowercase the rest.
---
---```lua
---capitalize("foo_bar-baz") --> "Foo_bar-baz"
---capitalize("FooBar baz")  --> "Foobar baz"
---```
---
---@section Letter Case
---@param s string Input string.
---@return string capitalized Capitalized string.
---@nodiscard
function M.capitalize(s) end

---
---Convert string to sentence case (first letter uppercase, rest unchanged).
---
---```lua
---sentence("foo_bar-baz") --> "Foo_bar-baz"
---sentence("FooBar baz")  --> "FooBar baz"
---```
---
---@section Letter Case
---@param s string Input string.
---@return string sentenceCased Sentence-cased string.
---@nodiscard
function M.sentence(s) end

return M