@thi.ng/heaps - npm Package Compare versions

Comparing version 1.1.5 to 1.1.6

CHANGELOG.md

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

heap.d.ts

@@ -26,3 +26,3 @@ import { Comparator, ICopy, IEmpty, ILength, IStack } from "@thi.ng/api";
     [Symbol.iterator](): Generator<T, void, undefined>;
-    readonly length: number;
+    get length(): number;
     copy(): Heap<T>;
@@ -29,0 +29,0 @@ clear(): void;

package.json

 {
     "name": "@thi.ng/heaps",
-    "version": "1.1.5",
+    "version": "1.1.6",
     "description": "Generic binary heap & d-ary heap implementations with customizable ordering",
@@ -21,19 +21,22 @@ "module": "./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",
-        "mocha": "^6.1.4",
+        "@types/node": "^12.12.11",
+        "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"
     },
     "dependencies": {
-        "@thi.ng/api": "^6.5.0",
-        "@thi.ng/compare": "^1.0.10"
+        "@thi.ng/api": "^6.6.0",
+        "@thi.ng/compare": "^1.1.0"
     },
@@ -53,3 +56,6 @@ "keywords": [
     "sideEffects": false,
-    "gitHead": "97add769f24aa32a1a5e13c5c941605e1b9eb569"
+    "thi.ng": {
+        "year": 2017
+    },
+    "gitHead": "36c4d9e967bd80ccdbfa0f4a42f594080f95f105"
 }

README.md

@@ -0,1 +1,3 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
 # @thi.ng/heaps
@@ -10,8 +12,23 @@
 
+- [About](#about)
+  - [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [API](#api)
+- [Authors](#authors)
+- [License](#license)
+
 ## About
 
+Generic binary heap & d-ary heap implementations with customizable ordering.
+
 Type agnostic binary heap & d-ary heap implementations with customizable
 ordering and fanout / tree arity (in case of `DHeap`). Both `Heap` and
-`DHeap` have identical base API, however the former provides several additional operations.
+`DHeap` have an identical base API, however the former provides several
+additional operations.
 
+### Status
+
+**STABLE** - used in production
+
 ## Installation
@@ -28,4 +45,6 @@
 
-## Usage examples
+## API
 
+[Generated API docs](https://docs.thi.ng/umbrella/heaps/)
+
 ```ts
@@ -35,6 +54,8 @@ import { Heap, DHeap } from "@thi.ng/heaps";
 // with initial values, custom comparator and heap arity
-const h = new DHeap(
+const h = new DHeap<number>(
     [5, 2, 10, 15, 18, 23, 22, -1],
     {
-        compare: (a,b) => b - a,
+        // custom comparator
+        compare: (a, b) => b - a,
+        // branch size (DHeap only)
         d: 4
@@ -59,6 +80,6 @@ }
 
-- Karsten Schmidt
+Karsten Schmidt
 
 ## License
 
-&copy; 2017 - 2018 Karsten Schmidt // Apache Software License 2.0
+&copy; 2017 - 2019 Karsten Schmidt // Apache Software License 2.0

No alert changes

Improved metrics

Total package byte prevSize

66458

increased by7.93%

Number of package files

21

increased by31.25%

Number of lines in readme file

82

increased by34.43%

Worsened metrics

Dev dependency count

8

increased by33.33%

Dependency changes

• [e-mail]/api@^6.6.0

• [e-mail]/compare@^1.1.0