Adds is.[not].primitive To is (#15)

Adds `is.primitive` and `is.not.primitive` to `is`

The following results from `is.getType` will return `true` for
`is.primitive`. Everything else returns `false`.

* 'boolean',
* 'null',
* 'undefined',
* 'number',
* 'bigint',
* 'string',
* 'symbol'

dist/blueprint.js

@@ -650,6 +650,7 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
         number: undefined,
         nullOrWhitespace: undefined,
         decimal: undefined,
+        primitive: undefined,
         not: {
           defined: undefined,
           nullOrUndefined: undefined,
@@ -666,16 +667,17 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
           regexp: undefined,
           number: undefined,
           nullOrWhitespace: undefined,
-          decimal: undefined
+          decimal: undefined,
+          primitive: undefined
         }
-        /**
-         * Produces the printed type (i.e. [object Object], [object Function]),
-         * removes everything except for the type, and returns the lowered form.
-         * (i.e. boolean, number, string, function, asyncfunction, promise, array,
-         * date, regexp, object)
-         */
-
       };
+      var primitives = ['boolean', 'null', 'undefined', 'number', 'bigint', 'string', 'symbol'];
+      /**
+       * Produces the printed type (i.e. [object Object], [object Function]),
+       * removes everything except for the type, and returns the lowered form.
+       * (i.e. boolean, number, string, function, asyncfunction, promise, array,
+       * date, regexp, object)
+       */
 
       is.getType = function (obj) {
         return Object.prototype.toString.call(obj).replace(/(^\[object )|(\]$)/g, '').toLowerCase();
@@ -825,6 +827,14 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
         return is.decimal(val, places) === false;
       };
 
+      is.primitive = function (input) {
+        return primitives.indexOf(is.getType(input)) > -1;
+      };
+
+      is.not.primitive = function (input) {
+        return is.primitive(input) === false;
+      };
+
       return is;
     }
   };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polyn/blueprint",
-  "version": "2.4.2",
+  "version": "2.5.0",
   "description": "An easy to use, flexible, and powerful validation library for nodejs and browsers",
   "main": "index.js",
   "types": "index.d.ts",

src/is.js

@@ -21,6 +21,7 @@ module.exports = {
       number: undefined,
       nullOrWhitespace: undefined,
       decimal: undefined,
+      primitive: undefined,
       not: {
         defined: undefined,
         nullOrUndefined: undefined,
@@ -37,10 +38,21 @@ module.exports = {
         regexp: undefined,
         number: undefined,
         nullOrWhitespace: undefined,
-        decimal: undefined
+        decimal: undefined,
+        primitive: undefined
       }
     }
 
+    const primitives = [
+      'boolean',
+      'null',
+      'undefined',
+      'number',
+      'bigint',
+      'string',
+      'symbol'
+    ]
+
     /**
      * Produces the printed type (i.e. [object Object], [object Function]),
      * removes everything except for the type, and returns the lowered form.
@@ -203,6 +215,14 @@ module.exports = {
       return is.decimal(val, places) === false
     }
 
+    is.primitive = function (input) {
+      return primitives.indexOf(is.getType(input)) > -1
+    }
+
+    is.not.primitive = function (input) {
+      return is.primitive(input) === false
+    }
+
     return is
   }
 }

src/is.test.js

@@ -3,15 +3,24 @@ const expect = require('chai').expect
 module.exports = (test) => {
   const { is } = test.sut
 
+  const makeDescription = (func, name, value) => {
+    try {
+      return `${func}.${name}(${value})`
+    } catch (e) {
+      // ignore - symbols can't be coerced to strings
+      return `${func}.${name}(probably a symbol)`
+    }
+  }
+
   const assert = (name, values) => {
     values.is.forEach((value) => {
-      expect(is[name](value), `is.${name}(${value})`).to.equal(true)
-      expect(is.not[name](value), `is.not.${name}(${value})`).to.equal(false)
+      expect(is[name](value), makeDescription('is', name, value)).to.equal(true)
+      expect(is.not[name](value), makeDescription('is.not', name, value)).to.equal(false)
     })
 
     values.isNot.forEach((value) => {
-      expect(is[name](value), `is.${name}(${value})`).to.equal(false)
-      expect(is.not[name](value), `is.not.${name}(${value})`).to.equal(true)
+      expect(is[name](value), makeDescription('is', name, value)).to.equal(false)
+      expect(is.not[name](value), makeDescription('is.not', name, value)).to.equal(true)
     })
   }
 
@@ -349,6 +358,42 @@ module.exports = (test) => {
       expect(is.not.decimal(-42.42, 3)).to.equal(true)
       expect(is.not.decimal(42.4242424242, 12)).to.equal(true)
       expect(is.not.decimal(-42.4242424242, 12)).to.equal(true)
+    },
+    // primitive
+    'when `primitive` is executed': {
+      'it should return the expected responses': () => {
+        assert('primitive', {
+          is: [
+            true,
+            false,
+            'string',
+            null,
+            undefined,
+            0,
+            1,
+            42.4,
+            Infinity,
+            1n,
+            BigInt(Number.MAX_SAFE_INTEGER + Number.MAX_SAFE_INTEGER), // eslint-disable-line no-undef
+            Symbol(true),
+            Symbol(false),
+            Symbol('string'),
+            Symbol(null),
+            Symbol(undefined),
+            Symbol(0),
+            Symbol(1),
+            Symbol(42.4),
+            Symbol(1n)
+          ],
+          isNot: [
+            {},
+            { foo: 'bar' },
+            function () {},
+            () => {},
+            new Date()
+          ]
+        })
+      }
     }
   })
 }