@kristiandupont/recase
v1.4.0
Published
Change and detect the casing of a string.
Downloads
100,027
Readme
RECASE
Change and detect the casing of a string.
Install
npm i @kristiandupont/recase
Use
const { recase, detectCasing } = require("@kristiandupont/recase");
const initialCase = "snake";
const toCamel = recase(initialCase, "camel");
const toDash = recase(initialCase, "dash");
const s = "some_string_initially_set_with_snake_case";
console.log("Camel cased version:", toCamel(s));
// prints: "Camel cased version: someStringInitiallySetWithSnakeCase"
console.log("Dash cased version:", toDash(s));
// prints: "Dash cased version: some-string-initially-set-with-snake-case"
console.log("Casing detected:", detectCasing(s));
// prints: "Casing detected: snake"
recase
recase(from, to, str);
Takes two casing parameters which can both be one of dash
, snake
, camel
or pascal
. Additionally,
from
can be mixed
or null which will make all word boundaries considered.
The third parameter is the string to recase.
This function is curried which means that if you call it with fewer than three parameters, the return value
will be a new function, with the initial parameters bound. So if you want to have a function that converts
any string to a pascal-cased one, you can create it like so:
const toPascal = recase(null, "pascal");
console.log(toPascal("snake_case"));
// Prints: "SnakeCase"
detectCasing
detectCasing(str);
Takes a string that has been formatted. It will attempt to detect the casing.
Casings
dash
:example-string
screamingDash
:EXAMPLE-STRING
snake
:example_string
screamingSnake
:EXAMPLE_STRING
camel
:exampleString
pascal
:ExampleString
prose
:example string
capitalProse
:Example String