quack - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "quack",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Check the values of passed arguments in a function - see if they quack like a duck.",
@@ -14,3 +14,3 @@ "main": "quack.js",
     "type": "git",
-    "url": "[e-mail]:screenRev/quack.git"
+    "url": "[e-mail]:screenrev/quack.git"
   },
@@ -17,0 +17,0 @@ "keywords": [

README.md

@@ -1,4 +0,69 @@
-quack
-=====
+# quack
 
-Check the values of passed arguments in a function – see if they quack like a duck.
+Check the values of arguments passed to a function - see if they quack like a duck.
+
+
+## example
+
+```javascript
+var quack = require('quack');
+
+var coolFunction = function(string, array, object, number){
+    if (! quack('string, array, object, number', arguments)) {
+        throw new Error('is not a duck');
+    }
+    console.log('is a duck');
+};
+
+coolFunction('one', ['two'], {three: 3}, 'four'); // throws: "is not a duck", last arg is wrong
+coolFunction('one', ['two'], {three: 3}, 4); // logs: "is a duck", tick
+```
+
+
+## usage
+
+`quack` takes two arguments, and returns a `boolean` (`true` if it validates)
+
+- the expected *signature* (array or comma-separated string)
+- the *arguments* (`array` or `arguments` object)
+
+Two `arrays`:
+
+```
+quack(['string', 'number'], ['my string', 123]); // true
+```
+
+A `string` and `arguments` object:
+
+```
+var coolFunction = function(){
+    return quack('string, number', arguments);
+};
+coolFunction('my string', 123); // true
+```
+
+## validation types
+
+- **string**: `string` (primitive)
+- **number**: `number` (primitive)
+- **boolean**: `boolean` (primitive)
+- **object**: ECMAScript `object`,
+    including `array`, `function`, `object`, `regex`, `new Number(0)`, and `new String('')`
+- **array**: `array` (not including `arguments` object)
+
+
+## road map
+
+- 0.1: initial release, with `string`, `number`, `object`, & `array` (with tests)
+- 0.2: add `function`, `date`, `regex`, `arguments`, `simpleObject`
+- 0.3: shorthand
+    eg. `'"", {}, [], 1'` short for `'string, object, array, number'`
+- 0.4: `options`: a third argument
+    - *throws* `boolean`: throw and error if validation fails
+    - *console* `boolean`: log to the console if validation fails
+    - *message* `string`: a specific message for logged/thrown errors
+- 0.5: types of `arrays` & `object` properties
+    - `'string[]'`: an `array` of `strings`
+    - `'[string, number]'`: specific types within an `array`
+    - `'string{}'`: and `object` with only `string` properties
+    - `'{val1: string, val2: number}'`: specific `object` property names and types

test/values.js

@@ -27,3 +27,3 @@ // common types
 
-        // test common types, apart from exeptions
+        // test common types, minus exceptions
         var testAllExcept = function(except, fun){
@@ -30,0 +30,0 @@ if (typeof except == 'string') except = [except];

No alert changes

Improved metrics

Total package byte prevSize

61542

increased by488.07%

Number of package files

13

increased by18.18%

Number of lines in readme file

70

increased by1300%

No dependency changes