webgl-plot - npm Package Compare versions

Comparing version 0.5.8 to 0.6.0

dist/webglplot.d.ts

@@ -15,3 +15,3 @@ /**
 export { WebglLine, ColorRGBA, WebglStep, WebglPolar, WebglSquare };
-declare type WebGLPlotConfig = {
+declare type WebglPlotConfig = {
     antialias?: boolean;
@@ -27,3 +27,3 @@ transparent?: boolean;
  */
-export declare class WebGLPlot {
+export declare class WebglPlot {
     /**
@@ -123,3 +123,3 @@ * @private
      */
-    constructor(canvas: HTMLCanvasElement | OffscreenCanvas, options?: WebGLPlotConfig);
+    constructor(canvas: HTMLCanvasElement | OffscreenCanvas, options?: WebglPlotConfig);
     /**
@@ -126,0 +126,0 @@ * updates and redraws the content of the plot

dist/webglplot.js

@@ -316,3 +316,3 @@ class ColorRGBA {
  */
-class WebGLPlot {
+class WebglPlot {
     /**
@@ -577,2 +577,2 @@ * Create a webgl-plot instance
 
-export { ColorRGBA, WebGLPlot, WebglLine, WebglPolar, WebglSquare, WebglStep };
+export { ColorRGBA, WebglLine, WebglPlot, WebglPolar, WebglSquare, WebglStep };

dist/webglplot.umd.js

 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
     typeof define === 'function' && define.amd ? define(['exports'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.WebGLPlotBundle = {}));
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.WebglPlotBundle = {}));
 }(this, (function (exports) { 'use strict';
@@ -322,3 +322,3 @@
      */
-    class WebGLPlot {
+    class WebglPlot {
         /**
@@ -584,4 +584,4 @@ * Create a webgl-plot instance
     exports.ColorRGBA = ColorRGBA;
-    exports.WebGLPlot = WebGLPlot;
     exports.WebglLine = WebglLine;
+    exports.WebglPlot = WebglPlot;
     exports.WebglPolar = WebglPolar;
@@ -588,0 +588,0 @@ exports.WebglSquare = WebglSquare;

package.json

 {
   "name": "webgl-plot",
-  "version": "0.5.8",
+  "version": "0.6.0",
   "description": "High-performance 2D plotting library based on native WebGL",
@@ -15,2 +15,4 @@ "main": "./dist/webglplot.umd.js",
     "rollup": "^2.41.2",
+    "typedoc": "^0.20.31",
+    "typedoc-plugin-markdown": "^3.6.0",
     "typescript": "^4.2.3"
@@ -17,0 +19,0 @@ },

README.md

@@ -42,3 +42,3 @@ ![Npm Build](https://github.com/danchitnis/webgl-plot/workflows/Npm%20Build/badge.svg) ![Yarn Build](https://github.com/danchitnis/webgl-plot/workflows/Yarn%20Build/badge.svg) ![Code scanning](https://github.com/danchitnis/webgl-plot/workflows/Code%20scanning/badge.svg) ![Build](https://github.com/danchitnis/webgl-plot/workflows/Build/badge.svg)
 ```javascript
-import WebGLplot, { WebglLine, ColorRGBA } from "webgl-plot";
+import { WebGLplot, WebglLine, ColorRGBA } from "webgl-plot";
 ```
@@ -61,3 +61,3 @@
 const line = new WebglLine(color, numX);
-const wglp = new WebGLplot(canvas);
+const wglp = new WebglPlot(canvas);
 ```
@@ -138,3 +138,4 @@
 ```javascript
-import WebGLplot, {
+import {
+  WebglPlot,
   WebglLine,
@@ -158,2 +159,6 @@ ColorRGBA,
 
+## Internal test
+
+[ESM](https://danchitnis.github.io/webgl-plot/test/index-esm.html), [off-screen](https://danchitnis.github.io/webgl-plot/test/index-esm-off.html), [UMD](https://danchitnis.github.io/webgl-plot/test/index-umd.html)
+
 ## API Documentation
@@ -160,0 +165,0 @@

src/webglplot.ts

@@ -18,3 +18,3 @@ /**
 
-type WebGLPlotConfig = {
+type WebglPlotConfig = {
   antialias?: boolean;
@@ -31,3 +31,3 @@ transparent?: boolean;
  */
-export class WebGLPlot {
+export class WebglPlot {
   /**
@@ -149,3 +149,3 @@ * @private
    */
-  constructor(canvas: HTMLCanvasElement | OffscreenCanvas, options?: WebGLPlotConfig) {
+  constructor(canvas: HTMLCanvasElement | OffscreenCanvas, options?: WebglPlotConfig) {
     if (options == undefined) {
@@ -152,0 +152,0 @@ this.webgl = canvas.getContext("webgl", {

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

132907

increased by0.32%

Number of package files

46

increased by2.22%

Lines of code

3263

increased by0.18%

Number of lines in readme file

178

increased by2.89%

Worsened metrics

Dev dependency count

7

increased by40%

No dependency changes