@thi.ng/equiv - npm Package Compare versions

Comparing version 1.0.10 to 1.0.11

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [1.0.11](https://github.com/thi-ng/umbrella/compare/@thi.ng/equiv@[e-mail]/equiv@1.0.11) (2019-11-30)
+
+**Note:** Version bump only for package @thi.ng/equiv
+
+
+
+
+
 ## [1.0.10](https://github.com/thi-ng/umbrella/compare/@thi.ng/equiv@[e-mail]/equiv@1.0.10) (2019-11-09)
@@ -8,0 +16,0 @@

package.json

 {
     "name": "@thi.ng/equiv",
-    "version": "1.0.10",
-    "description": "Extensible deep equivalence checking for any data types",
+    "version": "1.0.11",
+    "description": "Extensible deep value equivalence checking for any data types",
     "module": "./index.js",
@@ -21,16 +21,19 @@ "main": "./lib/index.js",
         "build:test": "rimraf build && tsc -p test/tsconfig.json",
-        "test": "yarn build:test && mocha build/test/*.js",
-        "cover": "yarn build:test && nyc mocha build/test/*.js && nyc report --reporter=lcov",
+        "test": "mocha test",
+        "cover": "nyc mocha test && nyc report --reporter=lcov",
         "clean": "rimraf *.js *.d.ts .nyc_output build coverage doc lib",
-        "doc": "node_modules/.bin/typedoc --mode modules --out doc --ignoreCompilerErrors src",
+        "doc:readme": "../../scripts/generate-readme",
+        "doc": "node_modules/.bin/typedoc --mode modules --out doc src",
         "pub": "yarn build:release && yarn publish --access public"
     },
     "devDependencies": {
+        "@istanbuljs/nyc-config-typescript": "^0.1.3",
         "@types/mocha": "^5.2.6",
-        "@types/node": "^12.6.3",
+        "@types/node": "^12.12.11",
         "benchmark": "^2.1.4",
-        "mocha": "^6.1.4",
+        "mocha": "^6.2.2",
         "nyc": "^14.0.0",
-        "typedoc": "^0.15.0",
-        "typescript": "^3.6.4"
+        "ts-node": "^8.5.2",
+        "typedoc": "^0.15.2",
+        "typescript": "^3.7.2"
     },
@@ -50,5 +53,2 @@ "keywords": [
     },
-    "browserslist": [
-        "since 2018-07"
-    ],
     "browser": {
@@ -59,3 +59,3 @@ "process": false,
     "sideEffects": false,
-    "gitHead": "97add769f24aa32a1a5e13c5c941605e1b9eb569"
+    "gitHead": "36c4d9e967bd80ccdbfa0f4a42f594080f95f105"
 }

README.md

@@ -0,1 +1,3 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
 # @thi.ng/equiv
@@ -10,20 +12,31 @@
 
+- [About](#about)
+  - [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [API](#api)
+  - [Implement IEquiv interface](#implement-iequiv-interface)
+- [Authors](#authors)
+- [License](#license)
+
 ## About
 
-Extensible deep equivalence checking for any data types. Supports:
+Extensible deep value equivalence checking for any data types.
 
+Supports:
+
 - JS primitives
-- arrays
-- plain objects
+- Arrays
+- Plain objects
 - ES6 Sets / Maps
 - Date
 - RegExp
-- types with `.equiv()` implementations
-  ([IEquiv](https://github.com/thi-ng/umbrella/tree/master/packages/api/src/api.ts#L213)
-  interface)
+- Types with
+  [IEquiv](https://github.com/thi-ng/umbrella/tree/master/packages/api/src/api/equiv.ts)
+  implementation
 
-This feature was previously part of the
-[@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
-package.
+### Status
 
+**STABLE** - used in production
+
 ## Installation
@@ -37,10 +50,15 @@
 
-- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/master/packages/checks)
+None
 
-## Usage examples
+## API
 
+[Generated API docs](https://docs.thi.ng/umbrella/equiv/)
+
 ```ts
 import { equiv } from "@thi.ng/equiv";
 
-equiv({a: {b: [1, 2]}}, {a: {b: [1, 2]}});
+equiv(
+    { a: { b: [1, 2] } },
+    { a: { b: [1, 2] } }
+);
 // true
@@ -54,3 +72,3 @@ ```
 
-Furthemore by implementing this interface we can better control which
+Furthermore, by implementing this interface we can better control which
 internal values / criteria are required to establish equivalence. In
@@ -69,3 +87,3 @@ this example we exclude the `meta` property and only check for same type
 
-    constructor(children: any[], meta?) {
+    constructor(children: any[], meta?: any) {
         this.children = children;
@@ -86,6 +104,6 @@ this.meta = meta;
 
-- Karsten Schmidt
+Karsten Schmidt
 
 ## License
 
-&copy; 2018 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35282

increased by7.67%

Number of package files

13

increased by18.18%

Number of lines in readme file

105

increased by20.69%

Worsened metrics

Dev dependency count

9

increased by28.57%

No dependency changes