Function toSnakeCase

Converts a string to snake_case.

Remarks

This function converts a string to kebab-case, which is a naming convention where multiple words are joined together with underscores (_) and all characters are lowercase.

Example

Converting a string with spaces to snake_case:

toSnakeCase('hello world')
// => { ok: true, value: 'hello_world' }
Copy

Example

Converting a string with hyphens to snake_case:

toSnakeCase('fooBarBaz')
// => { ok: true, value: 'foo_bar_baz' }
Copy

Example

Handling non-string input:

toSnakeCase(42)
// => { ok: false, error: Error('[strings.toSnakeCase] Expected string value as input') }
Copy