@thi.ng/quad-edge - npm Package Compare versions

Comparing version 0.2.3 to 0.2.4

CHANGELOG.md

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

index.d.ts

@@ -44,7 +44,7 @@ /**
      */
-    readonly oprev: Edge<T>;
+    get oprev(): Edge<T>;
     /**
      * Dual of this edge, right -> left.
      */
-    readonly rot: Edge<T>;
+    get rot(): Edge<T>;
     /**
@@ -54,3 +54,3 @@ * Dual of this edge, left -> right.
      */
-    readonly invrot: Edge<T>;
+    get invrot(): Edge<T>;
     /**
@@ -60,11 +60,11 @@ * Symmetric partner edge of this edge, from dest -> src.
      */
-    readonly sym: Edge<T>;
+    get sym(): Edge<T>;
     /**
      * Next CCW edge to this edge's dest.
      */
-    readonly dnext: Edge<T>;
+    get dnext(): Edge<T>;
     /**
      * Next CW edge to this edge's dest.
      */
-    readonly dprev: Edge<T>;
+    get dprev(): Edge<T>;
     /**
@@ -74,3 +74,3 @@ * Next CCW edge around the left face (dual vertex) from this edge's
      */
-    readonly lnext: Edge<T>;
+    get lnext(): Edge<T>;
     /**
@@ -80,3 +80,3 @@ * Next CCW edge around the left face (dual vertex) to this edge's
      */
-    readonly lprev: Edge<T>;
+    get lprev(): Edge<T>;
     /**
@@ -86,3 +86,3 @@ * Next CCW edge around the right face (dual vertex) to this edge's
      */
-    readonly rnext: Edge<T>;
+    get rnext(): Edge<T>;
     /**
@@ -92,7 +92,7 @@ * Next CCW edge around the right face (dual vertex) to this edge's
      */
-    readonly rprev: Edge<T>;
+    get rprev(): Edge<T>;
     /**
      * Returns this edge's dest vertex. I.e. `this.sym.origin`
      */
-    readonly dest: T;
+    get dest(): T;
     /**
@@ -99,0 +99,0 @@ * Sets the origin & dest vertices of this edge (in other words, the

package.json

 {
     "name": "@thi.ng/quad-edge",
-    "version": "0.2.3",
+    "version": "0.2.4",
     "description": "Quadedge data structure after Guibas & Stolfi",
@@ -21,15 +21,18 @@ "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"
     },
@@ -50,3 +53,9 @@ "keywords": [
     "sideEffects": false,
-    "gitHead": "97add769f24aa32a1a5e13c5c941605e1b9eb569"
+    "thi.ng": {
+        "related": [
+            "geom-voronoi"
+        ],
+        "year": 2015
+    },
+    "gitHead": "36c4d9e967bd80ccdbfa0f4a42f594080f95f105"
 }

README.md

@@ -0,4 +1,6 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
 # @thi.ng/quad-edge
 
-[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/quad-edge.svg)](https://www.npmjs.com/package/@thi.ng/quad-edge)
+[![npm version](https://img.shields.io/npm/v/@thi.ng/quad-edge.svg)](https://www.npmjs.com/package/@thi.ng/quad-edge)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/quad-edge.svg)
@@ -10,18 +12,14 @@ [![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
 
-<!-- TOC depthFrom:2 depthTo:3 -->
-
 - [About](#about)
+  - [Status](#status)
+  - [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
-- [Usage examples](#usage-examples)
+- [API](#api)
 - [Authors](#authors)
 - [License](#license)
 
-<!-- /TOC -->
-
 ## About
 
-Quad-edge data structure after Guibas & Stolfi: _Primitives for the
-manipulation of general subdivisions and the computation of Voronoi
-diagrams, ACM Transactions on Graphics, 4, 1985, p.75-123_
+Quadedge data structure after Guibas & Stolfi.
 
@@ -37,3 +35,14 @@ See the related
 - https://github.com/thi-ng/c-thing/blob/master/src/geom/quadedge.h
+- Guibas & Stolfi: _Primitives for the manipulation of general
+  subdivisions and the computation of Voronoi diagrams, ACM Transactions
+  on Graphics, 4, 1985, p.75-123_
 
+### Status
+
+**STABLE** - used in production
+
+### Related packages
+
+- [@thi.ng/geom-voronoi](https://github.com/thi-ng/umbrella/tree/master/packages/geom-voronoi) - Fast, incremental 2D Delaunay & Voronoi mesh implementation
+
 ## Installation
@@ -47,16 +56,16 @@
 
-- None
+None
 
-## Usage examples
+## API
 
-```ts
-import { Edge } from "@thi.ng/quad-edge";
-```
+[Generated API docs](https://docs.thi.ng/umbrella/quad-edge/)
 
+TODO
+
 ## Authors
 
-- Karsten Schmidt
+Karsten Schmidt
 
 ## License
 
-&copy; 2018 Karsten Schmidt // Apache Software License 2.0
+&copy; 2015 - 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

38505

increased by8.43%

Number of package files

12

increased by20%

Number of lines in readme file

69

increased by15%

Worsened metrics

Dev dependency count

8

increased by33.33%

No dependency changes