@eik/common - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [1.1.0](https://github.com/eik-lib/common/compare/v1.0.1...v1.1.0) (2020-09-10)
+
+
+### Features
+
+* add assert functions for schema ([ba3aa28](https://github.com/eik-lib/common/commit/ba3aa28d2450d2ef6ebf58ba716427164f849680))
+
 ## [1.0.1](https://github.com/eik-lib/common/compare/v1.0.0...v1.0.1) (2020-09-10)
@@ -2,0 +9,0 @@

lib/schemas/index.js

@@ -5,4 +5,6 @@ 'use strict';
 const validate = require('./validate');
+const assert = require('./assert');
 
 module.exports.schema = schema;
-module.exports.validate = validate;
+module.exports.validate = validate;
+module.exports.assert = assert;

package.json

 {
   "name": "@eik/common",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Common utilities for Eik modules",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -14,3 +14,3 @@ # Eik Commons
 ```js
-const { schemas } = require('@eik/common');
+const { schemas, assert } = require('@eik/common');
 ```
@@ -27,2 +27,11 @@
 });
+
+//or 
+
+assert.eikJSON({
+    name: 'my-app',
+    version: '1.0.0',
+    server: 'http://eik-server',
+    files: [],
+});
 ```
@@ -36,2 +45,6 @@
 const { error, value } = schemas.validate.name('my-app');
+
+// or
+
+assert.name('my-app');
 ```
@@ -43,2 +56,6 @@
 const { error, value } = schemas.validate.version('1.0.0');
+
+// or
+
+assert.version('1.0.0');
 ```
@@ -49,2 +66,6 @@ ##### server
 const { error, value } = schemas.validate.server('http://myeikserver.com');
+
+// or
+
+assert.server('http://myeikserver.com');
 ```
@@ -57,2 +78,8 @@ ##### files
 });
+
+// or
+
+assert.files({
+    './index.js': '/path/to/file.js'
+});
 ```
@@ -69,2 +96,9 @@
 ]);
+
+// or
+
+assert.importMap([
+    'http://meserver.com/map1.json',
+    'http://meserver.com/map2.json',
+]);
 ```
@@ -76,2 +110,6 @@
 const { error, value } = schemas.validate.out('./.eik');
+
+// or
+
+assert.out('./.eik');
 ```

No alert changes

Improved metrics

Total package byte prevSize

12848

increased by18%

Number of package files

11

increased by10%

Lines of code

285

increased by14.92%

Number of lines in readme file

108

increased by54.29%

No dependency changes