Update docs

book.json

@@ -1,5 +1,5 @@
 { 
-  "gitbook": "2.5.2",
+  "gitbook": "2.x.x",
   "structure": { 
     "summary": "docs/SUMMARY.md" 
   } 

docs/SUMMARY.md

@@ -18,6 +18,7 @@
   * [fdef](docs/api/fdef.md)
   * [gen](docs/api/gen.md)
   * [intIn](docs/api/intIn.md)
+  * [isIntInRange](docs/api/isIntInRange.md)
   * [isValid](docs/api/isValid.md)
   * [keys](docs/api/keys.md)
   * [mapOf](docs/api/mapOf.md)

docs/api-reference.md

@@ -1,10 +1,15 @@
 Descriptions for the different functions where copied from the original 
 [clojure.spec api description](https://clojure.github.io/clojure/branch-master/clojure.spec-api.html).
 
-| clojure.spec | speculaas |
-|:---------:|:--------:|
-| &       | amp    |
-| +       | plus   |
-| *       | star   |
-| col-of  | colOf  |
+| clojure.spec  | speculaas    |
+|:-------------:|:------------:|
+| &             | [amp](api/amp.md)          |
+| +             | [plus](api/plus.md)         |
+| *             | [star](api/star.md)         |
+| coll-of       | [collOf](api/collOf.md)       |
+| double-in     | [doubleIn](api/doubleIn.md)     |
+| int-in        | [intIn](api/intIn.md)        |
+| int-in-range? | [isIntInRange](api/isIntInRange.md) |
+| map-of        | [mapOf](api/mapOf.md)        |
+
 

docs/api/intIn.md

@@ -1,7 +1,7 @@
 intIn
 =====
 
-Usage: ```intIn(start end)```
+Usage: ```intIn(start, end)```
 
 Returns a spec that validates ints in the range from start (inclusive) to end (exclusive).
 

docs/api/isIntInRange.md

@@ -0,0 +1,20 @@
+isIntInRange
+=====
+
+Usage: ```isIntInRange(start, end, val)```
+
+Return true if start <= val and val < end
+
+[Source](https://github.com/mrijk/speculaas/blob/master/lib/intIn.js)
+
+Example:
+
+```js
+const s = require('speculaas');
+
+s.isIntInRange(0, 13, 0);
+// true
+
+s.isIntInRange(0, 13, -42);
+// false
+```

docs/api/keys.md

@@ -0,0 +1,15 @@
+keys
+=====
+
+Usage: ```keys(...)```
+
+Creates and returns a map validating spec.
+
+[Source](https://github.com/mrijk/speculaas/blob/master/lib/keys.js)
+
+Example:
+
+```js
+const s = require('speculaas');
+const {isBoolean, isString} = require('lodash');
+```

test/keys.js

@@ -17,6 +17,7 @@ describe('Test the keys function', () => {
         s.def('::first-name', isString);
         s.def('::last-name', isString);
         s.def('::email', '::email-type');
+        s.def('::phone', isString);
         s.def('::person', s.keys({req: ['::first-name', '::last-name', '::email'], opt: ['::phone']}));
     });
 
@@ -28,6 +29,16 @@ describe('Test the keys function', () => {
                              '::email': 'elon@example.com'
                          })).to.be.true;
     });
+
+    it('should should accept object with required and optional keys', () => {
+        expect(s.isValid('::person',
+                         {
+                             '::first-name': 'Elon',
+                             '::last-name': 'Musk',
+                             '::email': 'elon@example.com',
+                             '::phone': '06 12345678'
+                         })).to.be.true;
+    });
 
     it('should fail if required key is missing', () => {
         expect(s.isValid('::person',