@trenskow/caseit 1.1.1 → 1.1.2

package/README.md

@@ -5,9 +5,25 @@ A small library for changing the case of a string.
 
 # Usage
 
-    const caseit = require('caseit');
-    
-    const myCamelCase = caseit('my_camel_case', 'camel'); // myCamelCase;
+Import using the following example.
+
+````javascript
+const caseit = require('@trenskow/caseit');
+````
+
+– or
+
+````javascript
+import caseit from '@trenskow/caseit'
+````
+
+## Converting
+
+To convert from one case type to another use the following example.
+
+```javascript
+const myCamelCase = caseit('my_camel_case', 'camel'); // return 'myCamelCase';
+```
 
 You can convert from any format to any other format. Supported formats are.
 
@@ -19,7 +35,24 @@ You can convert from any format to any other format. Supported formats are.
  * `title` - Title Case
  * `http` - Http-Case
 
-> Default format (if omitted) is `camel`.
+> Default format (if omitted) is `camel` (because it is the Javascript default).
+
+## Detecting
+
+To detect the casing of a string do as the following example.
+
+````javascript
+caseit.detect('MyCase'); // returns ['pascal']
+caseit.detect('Hello'); // returns ['pascal', 'title', 'http']
+````
+
+## Getting the words
+
+You can also get the lowercase variants of all the words in a string by using the following example.
+
+````javascript
+caseit.words('MyCase'); // returns ['my', 'case']
+````
 
 # LICENSE
 

package/index.js

@@ -1,22 +1,24 @@
 'use strict';
 
+const separators = {
+	'camel': '',
+	'pascal': '',
+	'snake': '_',
+	'domain': '.',
+	'kebab': '-',
+	'title': ' ',
+	'http': '-'
+};
+
+const supported = Object.keys(separators);
+
 module.exports = exports = function(input, type = 'camel') {
 
-	const separators = {
-		'camel': '',
-		'pascal': '',
-		'snake': '_',
-		'domain': '.',
-		'kebab': '-',
-		'title': ' ',
-		'http': '-'
-	};
-
-	if (Object.keys(separators).indexOf(type) == -1) {
+	if (!supported.includes(type)) {
 		throw new TypeError('Type must either be `camel`, `pascal`, `snake`, `domain`, `kebab`, `title`, `http`.');
 	}
 
-	const parts = input.split(/(?=[A-Z])|_|-| |\./)
+	const words = exports.words(input)
 		.filter((key) => key.length)
 		.map((key, idx) => {
 			switch (type) {
@@ -38,6 +40,16 @@ module.exports = exports = function(input, type = 'camel') {
 			}
 		});
 
-	return parts.join(separators[type]);
-					
+	return words.join(separators[type]);
+
+};
+
+exports.words = function(input) {
+	return input.split(/(?=[A-Z])|_|-| |\./)
+		.map((word) => word.toLowerCase());
+};
+
+exports.detect = function(input) {
+	return supported
+		.filter((type) => exports(input, type) === input);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trenskow/caseit",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Small library for converting between different casing.",
   "main": "index.js",
   "scripts": {