@thi.ng/associative - npm Package Compare versions

Comparing version 3.1.0 to 3.1.1

array-set.d.ts

@@ -15,5 +15,5 @@ import { Fn3, Pair } from "@thi.ng/api";
     [Symbol.iterator](): IterableIterator<T>;
-    readonly [Symbol.species]: typeof ArraySet;
-    readonly [Symbol.toStringTag]: string;
-    readonly size: number;
+    get [Symbol.species](): typeof ArraySet;
+    get [Symbol.toStringTag](): string;
+    get size(): number;
     copy(): ArraySet<T>;
@@ -20,0 +20,0 @@ empty(): ArraySet<T>;

CHANGELOG.md

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

equiv-map.d.ts

@@ -24,5 +24,5 @@ import { Fn3, ICopy, IEmpty, IEquiv, IObjectOf, Pair } from "@thi.ng/api";
     [Symbol.iterator](): IterableIterator<Pair<K, V>>;
-    readonly [Symbol.species]: typeof EquivMap;
-    readonly [Symbol.toStringTag]: string;
-    readonly size: number;
+    get [Symbol.species](): typeof EquivMap;
+    get [Symbol.toStringTag](): string;
+    get size(): number;
     clear(): void;
@@ -29,0 +29,0 @@ empty(): EquivMap<K, V>;

hash-map.d.ts

@@ -32,6 +32,6 @@ import { Fn, Fn3, ICopy, IEmpty, IEquiv, Pair, Predicate2 } from "@thi.ng/api";
     constructor(pairs: Iterable<Pair<K, V>> | null, opts: HashMapOpts<K>);
-    readonly [Symbol.species]: typeof HashMap;
-    readonly [Symbol.toStringTag]: string;
-    readonly size: number;
-    [Symbol.iterator](): IterableIterator<[K, V]>;
+    get [Symbol.species](): typeof HashMap;
+    get [Symbol.toStringTag](): string;
+    get size(): number;
+    [Symbol.iterator](): IterableIterator<Pair<K, V>>;
     entries(): IterableIterator<Pair<K, V>>;
@@ -38,0 +38,0 @@ keys(): IterableIterator<K>;

ll-set.d.ts

@@ -15,5 +15,5 @@ import { Fn3, Pair } from "@thi.ng/api";
     [Symbol.iterator](): IterableIterator<T>;
-    readonly [Symbol.species]: typeof LLSet;
-    readonly [Symbol.toStringTag]: string;
-    readonly size: number;
+    get [Symbol.species](): typeof LLSet;
+    get [Symbol.toStringTag](): string;
+    get size(): number;
     copy(): LLSet<T>;
@@ -20,0 +20,0 @@ empty(): LLSet<T>;

package.json

 {
     "name": "@thi.ng/associative",
-    "version": "3.1.0",
-    "description": "Alternative Set & Map data type implementations with customizable equality semantics & supporting operations",
+    "version": "3.1.1",
+    "description": "Alternative Map and Set implementations with customizable equality semantics & supporting operations",
     "module": "./index.js",
@@ -21,25 +21,28 @@ "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",
-        "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/binary": "^1.1.1",
-        "@thi.ng/checks": "^2.4.1",
-        "@thi.ng/compare": "^1.0.10",
-        "@thi.ng/dcons": "^2.1.6",
-        "@thi.ng/equiv": "^1.0.10",
-        "@thi.ng/errors": "^1.2.1",
-        "@thi.ng/transducers": "^6.0.0"
+        "@thi.ng/api": "^6.6.0",
+        "@thi.ng/binary": "^1.2.0",
+        "@thi.ng/checks": "^2.4.2",
+        "@thi.ng/compare": "^1.1.0",
+        "@thi.ng/dcons": "^2.2.0",
+        "@thi.ng/equiv": "^1.0.11",
+        "@thi.ng/errors": "^1.2.2",
+        "@thi.ng/transducers": "^6.1.0"
     },
@@ -69,3 +72,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/associative
@@ -10,7 +12,24 @@
 
+- [About](#about)
+  - [Why?](#why-)
+  - [Comparison with ES6 native types](#comparison-with-es6-native-types)
+  - [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [API](#api)
+  - [IEquivSet](#iequivset)
+  - [ArraySet](#arrayset)
+  - [LLSet](#llset)
+  - [EquivMap](#equivmap)
+  - [HashMap](#hashmap)
+  - [SortedMap](#sortedmap)
+    - [Ranged queries](#ranged-queries)
+  - [SortedSet](#sortedset)
+  - [SparseSet8/16/32](#sparseset8-16-32)
+- [Authors](#authors)
+- [License](#license)
+
 ## About
 
-This package provides alternative `Set` & `Map` data type
-implementations with customizable equality semantics, as well as common
-operations working with these types:
+Alternative Map and Set implementations with customizable equality semantics & supporting operations.
 
@@ -44,2 +63,9 @@ - Array based `ArraySet`, Linked List based `LLSet`,
 
+Please see these packages for use cases:
+
+- [@thi.ng/cache](https://github.com/thi-ng/umbrella/tree/master/packages/cache)
+- [@thi.ng/dgraph](https://github.com/thi-ng/umbrella/tree/master/packages/dgraph)
+- [@thi.ng/ecs](https://github.com/thi-ng/umbrella/tree/master/packages/ecs)
+- [@thi.ng/rstream-query](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-query)
+
 The native ES6 implementations use object reference identity to
@@ -133,2 +159,6 @@ determine key containment, but often it's more practical and useful to
 
+### Status
+
+**STABLE** - used in production
+
 ## Installation
@@ -143,3 +173,4 @@
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
-- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/master/packages/errors)
+- [@thi.ng/binary](https://github.com/thi-ng/umbrella/tree/master/packages/binary)
+- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/master/packages/checks)
 - [@thi.ng/compare](https://github.com/thi-ng/umbrella/tree/master/packages/compare)
@@ -151,8 +182,10 @@ - [@thi.ng/dcons](https://github.com/thi-ng/umbrella/tree/master/packages/dcons)
 
-## Types
+## API
 
+[Generated API docs](https://docs.thi.ng/umbrella/associative/)
+
 ### IEquivSet
 
 All `Set` implementations in this package implement the
-[IEquivSet](https://github.com/thi-ng/umbrella/tree/master/packages/associative/src/api.ts#L7)
+[IEquivSet](https://github.com/thi-ng/umbrella/tree/master/packages/associative/src/api.ts)
 interface, an extension of the native ES6 Set API.
@@ -279,14 +312,5 @@
 
-## Usage examples
-
-Please see these packages for use cases:
-
-- [@thi.ng/cache](https://github.com/thi-ng/umbrella/tree/master/packages/cache)
-- [@thi.ng/dgraph](https://github.com/thi-ng/umbrella/tree/master/packages/dgraph)
-- [@thi.ng/ecs](https://github.com/thi-ng/umbrella/tree/master/packages/ecs)
-- [@thi.ng/rstream-query](https://github.com/thi-ng/umbrella/tree/master/packages/rstream-query)
-
 ## Authors
 
-- Karsten Schmidt
+Karsten Schmidt
 
@@ -293,0 +317,0 @@ ## License

sorted-map.d.ts

@@ -29,3 +29,3 @@ import { Fn3, IObjectOf, Pair } from "@thi.ng/api";
     constructor(pairs?: Iterable<Pair<K, V>> | null, opts?: Partial<SortedMapOpts<K>>);
-    readonly [Symbol.species]: typeof SortedMap;
+    get [Symbol.species](): typeof SortedMap;
     [Symbol.iterator](): IterableIterator<Pair<K, V>>;
@@ -35,3 +35,3 @@ entries(key?: K, max?: boolean): IterableIterator<Pair<K, V>>;
     values(key?: K, max?: boolean): IterableIterator<V>;
-    readonly size: number;
+    get size(): number;
     clear(): void;
@@ -38,0 +38,0 @@ empty(): SortedMap<K, V>;

sorted-set.d.ts

@@ -30,5 +30,5 @@ import { Fn3, ICompare, Pair } from "@thi.ng/api";
     [Symbol.iterator](): IterableIterator<T>;
-    readonly [Symbol.species]: typeof SortedSet;
-    readonly [Symbol.toStringTag]: string;
-    readonly size: number;
+    get [Symbol.species](): typeof SortedSet;
+    get [Symbol.toStringTag](): string;
+    get size(): number;
     copy(): SortedSet<T>;
@@ -35,0 +35,0 @@ empty(): SortedSet<T>;

sparse-set.d.ts

@@ -14,4 +14,4 @@ import { Fn3, IEquiv, Pair, UIntArray } from "@thi.ng/api";
     [Symbol.iterator](): IterableIterator<number>;
-    readonly size: number;
-    readonly capacity: number;
+    get size(): number;
+    get capacity(): number;
     clear(): void;
@@ -35,4 +35,4 @@ equiv(o: any): boolean;
     constructor(n: number);
-    readonly [Symbol.species]: typeof SparseSet8;
-    readonly [Symbol.toStringTag]: string;
+    get [Symbol.species](): typeof SparseSet8;
+    get [Symbol.toStringTag](): string;
     copy(): SparseSet8;
@@ -44,4 +44,4 @@ empty(): SparseSet8;
     constructor(n: number);
-    readonly [Symbol.species]: typeof SparseSet16;
-    readonly [Symbol.toStringTag]: string;
+    get [Symbol.species](): typeof SparseSet16;
+    get [Symbol.toStringTag](): string;
     copy(): SparseSet16;
@@ -53,4 +53,4 @@ empty(): SparseSet16;
     constructor(n: number);
-    readonly [Symbol.species]: typeof SparseSet32;
-    readonly [Symbol.toStringTag]: string;
+    get [Symbol.species](): typeof SparseSet32;
+    get [Symbol.toStringTag](): string;
     copy(): SparseSet32;
@@ -57,0 +57,0 @@ empty(): SparseSet32;

utils.d.ts

@@ -0,1 +1,2 @@
+import { Pair } from "@thi.ng/api";
 export declare const empty: (x: any, ctor: Function) => any;
@@ -5,3 +6,3 @@ export declare const copy: (x: any, ctor: Function) => any;
 export declare const objValues: (src: any) => any[];
-export declare const ensureMap: <K, V>(x: Iterable<[K, V]>) => Map<K, V>;
+export declare const ensureMap: <K, V>(x: Iterable<Pair<K, V>>) => Map<K, V>;
 export declare const ensureSet: <T>(x: Iterable<T>) => Set<T>;

No alert changes

Improved metrics

Total package byte prevSize

282666

increased by11.13%

Number of package files

93

increased by45.31%

Lines of code

3807

increased by0.03%

Number of lines in readme file

314

increased by8.28%

Worsened metrics

Dev dependency count

8

increased by33.33%

Dependency changes

• [e-mail]/api@^6.6.0

• [e-mail]/binary@^1.2.0

• [e-mail]/checks@^2.4.2

• [e-mail]/compare@^1.1.0

• [e-mail]/dcons@^2.2.0

• [e-mail]/equiv@^1.0.11

• [e-mail]/errors@^1.2.2

• [e-mail]/transducers@^6.1.0