@aduh95/viz.js - npm Package Compare versions

Comparing version 3.0.0-beta.10 to 3.0.0-rc

CHANGELOG.md

@@ -11,2 +11,4 @@ # Changelog
   allows dynamic memory growth.
+- The JS code is now transpiled from TypeScript, and typings are packed within
+  the npm package. You can find the API documentation there!
 - The library is able to reset its internal error state, which makes the
@@ -17,4 +19,2 @@ [v2 wiki caveat](https://github.com/mdaines/viz.js/wiki/Caveats#rendering-graphs-with-user-input)
   you must use a worker (webworker or worker_thread).
-- The JS code is now transpiled from TypeScript, and typings are packed within
-  the npm package. You can find the API documentation there!
 - There is a synchronous version available for legacy Node.js support.
@@ -72,3 +72,3 @@
 - Upgrade deps:
-  - Upgrade Emscripten to 1.39.15
+  - Upgrade Emscripten to 1.39.16
   - Upgrade Graphviz to 2.44.0
@@ -78,3 +78,3 @@ - Upgrade Expat to 2.2.9
 - Change test chain:
-  - Upgrade Mocha to 7.1.1
+  - Upgrade Mocha to 7.x
   - Use Puppeteer instead of Selenium
@@ -81,0 +81,0 @@

dist/index.d.ts

@@ -5,3 +5,3 @@ /// <reference types="node" />
 declare type VizConstructorOptionsWorkerURL = {
-    workerURL: string;
+    workerURL: string | URL;
 };
@@ -12,7 +12,24 @@ declare type VizConstructorOptionsWorker = {
 export declare type VizConstructorOptions = VizConstructorOptionsWorkerURL | VizConstructorOptionsWorker;
+/**
+ * The Viz class provides an interface between the rendering worker(s) and the
+ * "main" thread.
+ */
 declare class Viz {
     private _wrapper;
-    constructor(options?: VizConstructorOptions);
     /**
-     * Renders a DOT graph to the specified format
+     * Constructs a new Viz instance.
+     *
+     * If the `workerURL` option is given, its value must be the URL of one of the
+     * rendering script files included in the distribution (E.G.:
+     * `render.browser.js`).
+     * If the worker option is given, its value must be a `Worker` object
+     * constructed with the URL or path of one of the rendering script files
+     * included in the distribution (E.G.: `render.node.js`).
+     *
+     * @param options An object containing option properties on the worker to use.
+     * @throws {Error} if no options are given.
+     */
+    constructor(options: VizConstructorOptions);
+    /**
+     * Renders a DOT graph to the specified format.
      * @param src DOT representation of the graph to render.
@@ -38,2 +55,2 @@ * @param options Options for the rendering engine.
 export default Viz;
-export { RenderOptions, GraphvizJSONOutput };
+export type { RenderOptions, GraphvizJSONOutput };

dist/render_async.d.ts

 import type { RenderOptions } from "./types";
-export default function renderStringSync(src: string, options?: RenderOptions): Promise<string>;
+/**
+ * Renders a DOT graph to the specified format.
+ * @param src DOT representation of the graph to render.
+ * @param options Options for the rendering engine.
+ * @returns Raw output of Graphviz as a string.
+ */
+export default function renderStringAsync(src: string, options?: RenderOptions): Promise<string>;

dist/render_async.js

 /**
- * Viz.js 3.0.0-beta.10 (Graphviz 2.44.0, Expat 2.2.9, Emscripten 1.39.15)
+ * Viz.js 3.0.0-rc (Graphviz 2.44.0, Expat 2.2.9, Emscripten 1.39.16)
  * @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT licensed
@@ -4,0 +4,0 @@ *

dist/render_sync.d.ts

 import type { RenderOptions } from "./types";
+/**
+ * Renders a DOT graph to the specified format.
+ * @param src DOT representation of the graph to render.
+ * @param options Options for the rendering engine.
+ * @returns Raw output of Graphviz as a string.
+ */
 export default function renderStringSync(src: string, options?: RenderOptions): string;

package.json

 {
   "name": "@aduh95/viz.js",
-  "version": "3.0.0-beta.10",
+  "version": "3.0.0-rc",
   "description": "A hack to put Graphviz on the web.",
@@ -63,3 +63,3 @@ "main": "./dist/index.cjs",
   "devDependencies": {
-    "@types/node": "^13.5.3",
+    "@types/node": "^14.0.4",
     "@typescript-eslint/eslint-plugin": "^2.28.0",
@@ -75,4 +75,4 @@ "@typescript-eslint/parser": "^2.28.0",
     "terser": "^4.6.3",
-    "typescript": "^3.9.0-beta"
+    "typescript": "^3.9.3"
   }
 }

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

3373034

increased by0.02%

Lines of code

8950

increased by0.31%

No dependency changes