[fix] broken tests, and exact support for #scrub

dist/browser/not.js

@@ -1,5 +1,5 @@
 /*!
- * you-are-not v1.0.4
+ * you-are-not v1.0.5
  * (c) 2020-2021 calvintwr
  * Release under MIT license.
  */
@@ -477,9 +477,10 @@ var You = {
     return this.are(expect, got, name, note);
   } // scrub is a shorthand of #checkObject
   ,
-  scrub: function scrub(name, expectObject, gotObject) {
+  scrub: function scrub(name, expectObject, gotObject, exact) {
     return this.checkObject(name, expectObject, gotObject, {
-      returnPayload: true
+      returnPayload: true,
+      exact: exact
     });
   }
 };

package.json

@@ -1,6 +1,6 @@
 {
     "name": "you-are-not",
-    "version": "1.0.4",
+    "version": "1.0.5",
     "description": "Runtime type-checking written in TypeScript -- Not is a minimal, blazing fast, intuitive, API-centric, and customisable API payload sanitiser/type-checking/validation/error handing and messaging helper -- all in a small and neat pack.",
     "main": "index.cjs",
     "exports": {

readme.md

@@ -64,10 +64,11 @@ const schema = {
 let sanitised = Not.scrub(
     'payloadWithTypeError', // give your payload a name
     schema,
-    payload
+    payload,
+    { exact: true } // use exact: true if you need the payload to match the schema 100%, else, additional properties will be removed without throwing errors.
 )
 ```
-**API error resNot throws an actionable error message:**
+**Not throws an actionable error message ready for sending back to the requestor:**
 ```
 TypeError (NotTS): Wrong types provided. See `trace`.
     ... stack trace ...
@@ -83,13 +84,13 @@ If you are using express or fastify, thrown errors can be seamlessly used for pr
 //express
 res.status(sanitised.statusCode)
 res.send({
-    message: `You have provided erroneous inputs. \n\nMore info:\n${sanitised.track.join('\n')}`
+    message: `You have provided erroneous inputs. \n\nMore info:\n${sanitised.trace.join('\n')}`
 })
 
 //fastify
 reply.code(sanitised.statusCode)
 reply.send({
-    message: `You have provided erroneous inputs. \n\nMore info:\n${sanitised.track.join('\n')}`
+    message: `You have provided erroneous inputs. \n\nMore info:\n${sanitised.trace.join('\n')}`
 })
 ```
 This will produce a `400` error with the follow `message` property in response body:
@@ -135,7 +136,7 @@ const is = Not.createIs()
 const notNerfed = Not.create({ throw: false }) // creates an instance that will not throw errors.
 ```
 
-Use *Not* to cuts down runtime type-checking verbiage. Instead of:
+Use *Not* to cut down runtime type-checking verbiage. Instead of:
 
 ```js
 if (typeof foo !== 'string' ||
@@ -201,8 +202,9 @@ Other custom types:
 #checkObject is #scrub under the hood. Use #scrub for simplified usage (example above), and #checkObject when you want more control.
 
 ```js
-Not.scrub(objectName, schema, payload, { exact: true/false} )
-Not.checkObject(objectName, schema, payload, options)
+Not.scrub(objectName, schema, payload, options)
+
+Not.checkObject(objectName, schema, payload, callback/options)
 ```
 
 `objectName`: (string) Name of object.
@@ -211,7 +213,22 @@ Not.checkObject(objectName, schema, payload, options)
 
 `payload`: (object) The payload to check for.
 
-`callback/options`: (function or object | optional). To receive a sanitised payload, set options `returnPayload` to `true` (see examples below).
+`options` (#scrub): (object | optional). Define `exact: true` if you want to throw error if there are additional properties.
+
+`callback/options` (#checkObject): (object | optional). See example below:
+
+```js
+// callback
+Not.checkObject(objectName, schema, payload, (errors, payload) => { /* handle errors yourself*/ })
+
+// options
+Not.checkObject(objectName, schema, payload, {
+    callback: (errors, payload) => { /* handle errors yourself*/ },
+    returnPayload: true/false, // define if you need the payload returned. if not requires, switch to false for better performance
+    exact: true/false // if true, will throw errors if there are additiona properties
+})
+```
+
 
 #### Defining Schema
 

src/You.ts

@@ -156,7 +156,7 @@ const You: YouType = {
         , callback?: {
             callback?: CallbackFn
             , returnPayload?: boolean
-            , exact?: true
+            , exact?: boolean | undefined
         } | CallbackFn
 
     ): Object | string {
@@ -610,9 +610,10 @@ const You: YouType = {
         name: string
         , expectObject: GenericObj
         , gotObject: GenericObj
+        , exact?: true
 
     ): Object | string {
-        return this.checkObject(name, expectObject, gotObject, { returnPayload: true })
+        return this.checkObject(name, expectObject, gotObject, { returnPayload: true, exact })
     }
 
 }

src/core/types/You.ts

@@ -31,6 +31,7 @@ interface YouType  {
         , callback?: {
             callback?: CallbackFn
             , returnPayload?: boolean
+            , exact?: true
         } | CallbackFn
     ) => Object | string
 
@@ -45,6 +46,7 @@ interface YouType  {
         name: string
         , expectObject: GenericObj
         , gotObject: GenericObj
+        , exact?: true
 
     ) => Object | string
 

test/_are.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/_are.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/checkObject.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/checkObject.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/createIs.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/createIs.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 
 chai.should()

test/defineType.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/defineType.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 
 chai.should()

test/index.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 import chai from 'chai'
 chai.should()

test/index.throw.false.test.js

@@ -1,8 +1,6 @@
 'use strict'
 
-//const Not = require('../index.js')
-// ES6
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 const Not = NotProto.create({ throw: false })
 
 // ES6 Shorthand

test/lodge.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 chai.should()
 

test/lodge.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 chai.should()
 

test/msgPOJO.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/msgPOJO.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/prepareExpect.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 
 chai.should()

test/prepareExpect.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 
 chai.should()

test/resolve.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/resolve.throw.false.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import NotProto from '../index.js'
+import NotProto from '../index.cjs'
 import chai from 'chai'
 
 chai.should()

test/scrub.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/timestamp.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()

test/verbose.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-import Not from '../index.js'
+import Not from '../index.cjs'
 import chai from 'chai'
 import NotTypeError from '../dist/node/core/NotTypeError.js'
 chai.should()