kennitala - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

kennitala.js

@@ -5,5 +5,9 @@ (function () {
 
-	kennitala.isValidPerson = function(kennitala){
+	kennitala.isPerson = function(kennitala){
 		var kt = formatKennitala(kennitala);
 
+		if (kt.length !== 10) {
+			return false;
+		};
+
 		if (!isPerson(kt)) {
@@ -24,5 +28,9 @@ return false;
 
-	kennitala.isValidCompany = function(kennitala){
+	kennitala.isCompany = function(kennitala){
 		var kt = formatKennitala(kennitala);
 
+		if (kt.length !== 10) {
+			return false;
+		};
+
 		if (!isCompany(kt)) {
@@ -29,0 +37,0 @@ return false;

package.json

 {
   "name": "kennitala",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A validator module to check the checksum of Icelandic kennitölur",
@@ -8,9 +8,13 @@ "main": "kennitala.js",
   "license": "ISC",
-  "repository" :{ 
-  	"type" : "git",
-  	"url" : "https://github.com/HermannBjorgvin/Kennitala.git"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HermannBjorgvin/Kennitala.git"
   },
   "scripts": {
-    "test": "node test/test.js"
+    "test": "grunt && node test/test.js"
+  },
+  "devDependencies": {
+    "grunt": "^0.4.5",
+    "grunt-contrib-uglify": "^0.9.2"
   }
 }

README.md

 # Kennitala
-A validator for Icelandic kennitölur
+A validator for Icelandic kennitölur in node
 
-Installing with npm:
+[![Build Status](https://travis-ci.org/HermannBjorgvin/Kennitala.svg?branch=master)](https://travis-ci.org/HermannBjorgvin/Kennitala)
 
-    $npm install kennitala
+Installation with npm:
 
+    $ npm install kennitala
+
 Compatible with CommonJS, AMD modules, regular Javascript.
@@ -12,2 +14,33 @@
 
+### Example of usage
+    var kennitala = require('kennitala');
+    
+    kennitala.clean('310896DIRTYSSID2099'); // '3108962099'
+    kennitala.clean(3108962099);            // '3108962099'
+    
+    kennitala.isPerson('3108962099');            // True
+    kennitala.isPerson('310896-2099');           // True
+    kennitala.isPerson(3108962099);              // True
+    kennitala.isPerson('31^_^08!!96LOL20T_T99'); // True
+    
+    kennitala.isCompany('6010100890');  // True
+    kennitala.isCompany('601010-0890'); // True
+    kennitala.isCompany(6010100890);    // True
+
+### API
+    kennitala.clean([string, int]);
+        returns string
+    
+        Ensures datatype is string, then matches and removes all non-digit characters. Does not ensure the remaining string is 10 characters
+    
+    kennitala.isPerson([string, int]);
+        returns boolean
+    
+        Checks if kennitala checksum is correct and if day of birth is between 1-31
+    
+    kennitala.isCompany([string, int]);
+        returns boolean
+    
+        Checks if kennitala checksum is correct and if day of birth is between 41-71
+
 ### Things to add:
@@ -14,0 +47,0 @@

test/test.js

 
-console.log('Oh my god, something went terribly terribly wrong! Oh the humanities!');
+var kennitala = require('../kennitala.js');
+var ktmin = require('../kennitala-min.js');
+
+function failedTestError(){
+	throw new Error('General error, test failed or gave unexpected response');	
+}
+
+// -----------------------------
+// | Valdiate human kennitölur |
+// -----------------------------
+try {
+
+}
+catch (e) {
+	throw e;
+}
+
+// -------------------------------
+// | Valdiate company kennitölur |
+// -------------------------------
+try {
+	
+}
+catch (e) {
+	throw e;
+}
+
+// ----------------------------
+// | Validate .clean() method |
+// ----------------------------
+try {
+	
+}
+catch (e) {
+	throw e;
+}

No alert changes

Improved metrics

Total package byte prevSize

7736

increased by75.7%

Number of package files

9

increased by50%

Lines of code

105

increased by84.21%

Number of lines in readme file

50

increased by194.12%

Worsened metrics

Dev dependency count

2

increased byInfinity%

No dependency changes