docs: fix inconsistencies #3; fix flatmap to make it mildly simpler

README.md

@@ -99,7 +99,7 @@ The general shape it uses is:
       "type": "string"
     }
   },
-  "required": ["name"]
+  "required": ["username"]
 }
 ```
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mikrovalid",
   "description": "MikroValid is the JSON validator that cuts out all the bullshit.",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "author": "Mikael Vesavuori",
   "license": "MIT",
   "main": "./lib/index.js",

src/domain/MikroValid.ts

@@ -16,20 +16,20 @@ export class MikroValid {
    * takes care of the rest.
    *
    * @example
-   * import { MikroValid } from './MikroValid';
+   * import { MikroValid } from 'mikrovalid';
    *
    * const mikrovalid = new MikroValid();
    *
    * const schema = {
    *   properties: {
    *     personal: {
-   *       name: 'string',
+   *       name: { type: 'string' },
    *       required: ['name']
    *     },
    *     work: {
-   *       office: 'string',
-   *       currency: 'string',
-   *       salary: 'number',
+   *       office: { type: 'string' },
+   *       currency: { type: 'string' },
+   *       salary: { type: 'number' },
    *       required: ['office']
    *     },
    *     required: ['personal', 'work']
@@ -47,7 +47,7 @@ export class MikroValid {
    *   }
    * };
    *
-   * const { valid, errors } = mikrovalid.test(schema, input);
+   * const { success, errors } = mikrovalid.test(schema, input);
    *
    * console.log('Was the test successful?', success);
    */
@@ -69,7 +69,7 @@ export class MikroValid {
    */
   private compileErrors(results: Result[], errors: ValidationError[]): ValidationError[] {
     const resultErrors = results.filter((result: Result) => result.success === false);
-    return [...errors, resultErrors].flatMap((error: Result | Result[]) => error);
+    return [...errors, ...resultErrors].flatMap((error: Result) => error);
   }
 
   /**

tests/MikroValid.test.ts

@@ -886,25 +886,17 @@ test('It should work with the demo example', (t) => {
   const schema = {
     properties: {
       personal: {
-        name: {
-          type: 'string'
-        },
+        name: { type: 'string' },
         required: ['name']
       },
       work: {
-        office: {
-          type: 'string'
-        },
-        currency: {
-          type: 'string'
-        },
-        salary: {
-          type: 'number'
-        },
+        office: { type: 'string' },
+        currency: { type: 'string' },
+        salary: { type: 'number' },
         required: ['office']
-      }
-    },
-    required: ['personal', 'work']
+      },
+      required: ['personal', 'work']
+    }
   };
 
   const input = {