change-case
Advanced tools
change-case - npm Package Compare versions
Comparing version 2.0.0 to 2.0.1
| { | ||
| "name": "change-case", | ||
| "version": "2.0.0", | ||
| "version": "2.0.1", | ||
| "description": "Convert a string between camelCase, PascalCase, Title Case, snake_case, etc.", | ||
@@ -5,0 +5,0 @@ "main": "change-case.js", |
@@ -11,57 +11,52 @@ # Change Case | ||
| ## API | ||
| ## Usage | ||
| ```js | ||
| var changeCase = require('change-case'); | ||
| //=> { isUpperCase: [Function], ... } | ||
| ``` | ||
| **upperCase** changeCase.upperCase(string) | ||
| **isUpperCase** changeCase.isUpperCase(string) | ||
| Upper cases a string. | ||
| Return a boolean indicating the string is upper cased. | ||
| ```js | ||
| changeCase.upperCase('test string'); | ||
| --> "TEST STRING" | ||
| changeCase.isUpperCase('test string'); | ||
| //=> false | ||
| ``` | ||
| **lowerCase** changeCase.lowerCase(string) | ||
| **isLowerCase** changeCase.isLowerCase(string) | ||
| Lower cases a string. | ||
| Return a boolean indicating the string is lower cased. | ||
| ```js | ||
| changeCase.lowerCase('TEST STRING'); | ||
| --> "test string" | ||
| changeCase.isLowerCase('test string'); | ||
| //=> true | ||
| ``` | ||
| **upperCaseFirst** changeCase.upperCaseFirst(string) | ||
| **upperCase** changeCase.upperCase(string) | ||
| Upper cases only the first character of a string. | ||
| Return an upper cased string. | ||
| ```js | ||
| changeCase.upperCaseFirst('test string'); | ||
| --> "Test string" | ||
| changeCase.upperCase('test string'); | ||
| //=> "TEST STRING" | ||
| ``` | ||
| **lowerCaseFirst** changeCase.lowerCaseFirst(string) | ||
| **lowerCase** changeCase.lowerCase(string) | ||
| Lower cases only the first character of a string. | ||
| Return a lower cased string. | ||
| ```js | ||
| changeCase.lowerCaseFirst('TEST STRING'); | ||
| --> "tEST STRING" | ||
| changeCase.lowerCase('TEST STRING'); | ||
| //=> "test string" | ||
| ``` | ||
| **titleCase** changeCase.titleCase(string, capitalizeAll) | ||
| **titleCase** changeCase.titleCase(string) | ||
| Title cases a string, usually user inputted strings that should be displayed as titles. It attempts to correct formatting of the sentence. If you need to parse a string in a different format, trying passing it through `sentenceCase` first. | ||
| Return a space separated string with the first character of every word upper cased. | ||
| ```js | ||
| changeCase.titleCase('a simple test'); | ||
| --> "A Simple Test" | ||
| changeCase.titleCase('i found a bug'); | ||
| --> "I Found a Bug" | ||
| changeCase.titleCase('i found a bug', true); | ||
| --> "I Found A Bug" | ||
| //=> "A Simple Test" | ||
| ``` | ||
@@ -71,7 +66,7 @@ | ||
| Transforms a string from any format to a lower cased sentence. | ||
| Return a lower cased, space separated string. | ||
| ```js | ||
| changeCase.sentenceCase('testString'); | ||
| --> "test string" | ||
| //=> "test string" | ||
| ``` | ||
@@ -81,12 +76,21 @@ | ||
| Converts a string to a camel cased word. | ||
| Return a string with the separators denoted by having the next letter capitalized. | ||
| ```js | ||
| changeCase.camelCase('test string'); | ||
| --> "testString" | ||
| //=> "testString" | ||
| ``` | ||
| **pascalCase** changeCase.pascalCase(string) | ||
| Return a string denoted in the same fashion as `camelCase`, but with the first letter also capitalized. | ||
| ```js | ||
| changeCase.pascalCase('test string'); | ||
| //=> "TestString" | ||
| ``` | ||
| **snakeCase** changeCase.snakeCase(string) | ||
| Converts a string to an underscore separated string. | ||
| Return a lower cased, space separated string. | ||
@@ -100,7 +104,7 @@ ```js | ||
| Converts a string to a dash separated string. | ||
| Return a lower cased, dash separated string. | ||
| ```js | ||
| changeCase.paramCase('test string'); | ||
| --> "test-case" | ||
| //=> "test-case" | ||
| ``` | ||
@@ -110,7 +114,7 @@ | ||
| Converts a string to a period separated string. | ||
| Return a lower cased, period separated string. | ||
| ```js | ||
| changeCase.dotCase('test string'); | ||
| --> "test.string" | ||
| //=> "test.string" | ||
| ``` | ||
@@ -120,7 +124,7 @@ | ||
| Converts a string to a slash separated string. | ||
| Return a lower cased, slash separated string. | ||
| ```js | ||
| changeCase.pathCase('test string'); | ||
| --> "test/string" | ||
| //=> "test/string" | ||
| ``` | ||
@@ -130,16 +134,16 @@ | ||
| Converts a string to a constant styled string (upper case separated by underscores). | ||
| Return an upper cased, underscore separated string. | ||
| ```js | ||
| changeCase.constantCase('test string'); | ||
| --> "TEST_STRING" | ||
| //=> "TEST_STRING" | ||
| ``` | ||
| **switchCase** changeCase.switchCase(string) | ||
| **swapCase** changeCase.swapCase(string) | ||
| Reverses the strings case. | ||
| Return a string with lower case characters upper cased and upper case character lower cased. | ||
| ```js | ||
| changeCase.switchCase('Test String'); | ||
| --> "tEST sTRING" | ||
| changeCase.swapCase('Test String'); | ||
| //=> "tEST sTRING" | ||
| ``` | ||
@@ -146,0 +150,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.04%
11916
- Number of lines in readme file
- increased by2.8%
147
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes