ml-peak-shape-generator - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

CHANGELOG.md

 # Changelog
 
+### [2.0.1](https://www.github.com/mljs/peak-shape-generator/compare/v2.0.0...v2.0.1) (2021-08-09)
+
+
+### Bug Fixes
+
+* exhaustive switch and export interfaces ([#48](https://www.github.com/mljs/peak-shape-generator/issues/48)) ([590fbaa](https://www.github.com/mljs/peak-shape-generator/commit/590fbaa976de614fc637e208f46917cc023f657e))
+
 ## [2.0.0](https://www.github.com/mljs/peak-shape-generator/compare/v1.0.0...v2.0.0) (2021-08-06)
@@ -4,0 +11,0 @@

lib-esm/util/getShape1D.js

@@ -15,7 +15,9 @@ import { Gaussian } from '../shapes/1d/gaussian/Gaussian';
             return new PseudoVoigt(shapeOptions);
-        default:
+        default: {
+            const unHandled = kind;
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            throw new Error(`getShape1D: unknown shape kind: ${kind}`);
+            throw Error(`Unknown distribution ${unHandled}`);
+        }
     }
 }
 //# sourceMappingURL=getShape1D.js.map

lib-esm/util/getShape2D.js

@@ -9,7 +9,9 @@ import { Gaussian2D } from '../shapes/2d/gaussian2D/Gaussian2D';
             return new Gaussian2D(shapeOptions);
-        default:
+        default: {
+            const unHandled = kind;
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            throw new Error(`getShape2D: unknown shape kind: ${kind}`);
+            throw Error(`Unknown distribution ${unHandled}`);
+        }
     }
 }
 //# sourceMappingURL=getShape2D.js.map

lib/index.d.ts

@@ -9,1 +9,6 @@ export * as gaussian from './shapes/1d/gaussian/Gaussian';
 export * from './shapes/2d/Shape2D';
+export type { XYNumber } from './shapes/2d/gaussian2D/Gaussian2D';
+export type { GaussianClassOptions } from './shapes/1d/gaussian/Gaussian';
+export type { LorentzianClassOptions } from './shapes/1d/lorentzian/Lorentzian';
+export type { PseudoVoigtClassOptions } from './shapes/1d/pseudoVoigt/PseudoVoigt';
+export type { Gaussian2DClassOptions } from './shapes/2d/gaussian2D/Gaussian2D';

lib/shapes/1d/lorentzian/Lorentzian.d.ts

@@ -12,7 +12,2 @@ import { Shape1D } from '../Shape1D';
     fwhm?: number;
-    /**
-     * The halft width between the inflection points or standard deviation.
-     * If it is defined the fwhm would be re-assigned.
-     */
-    sd?: number;
 }
@@ -19,0 +14,0 @@ export interface GetDataOptions extends LorentzianClassOptions {

lib/shapes/2d/gaussian2D/Gaussian2D.d.ts

 import { Shape2D } from '../Shape2D';
-export { widthToFWHM, fwhmToWidth } from '../../1d/gaussian/Gaussian';
 export interface XYNumber {
@@ -7,3 +6,4 @@ x: number;
 }
-export interface Gaussian2DOptions {
+export { widthToFWHM, fwhmToWidth } from '../../1d/gaussian/Gaussian';
+export interface Gaussian2DClassOptions {
     /**
@@ -25,3 +25,3 @@ * The maximum z value of the shape
 }
-export interface GetDataOptions extends Gaussian2DOptions {
+export interface GetDataOptions extends Gaussian2DClassOptions {
     /**
@@ -63,3 +63,3 @@ * number of points along an specific axis.
     height: number;
-    constructor(options?: Gaussian2DOptions);
+    constructor(options?: Gaussian2DClassOptions);
     fct(x: number, y: number): number;
@@ -66,0 +66,0 @@ getData(options?: GetDataOptions): any[];

lib/shapes/2d/Shape2D.d.ts

 import { XYNumber } from './gaussian2D/Gaussian2D';
-export interface GetDat2DOptions {
+export interface GetData2DOptions {
     length?: number | XYNumber;
@@ -15,3 +15,3 @@ factor?: number | XYNumber;
     abstract getFactor(area?: number): number;
-    abstract getData(options: GetDat2DOptions): Float64Array[];
+    abstract getData(options: GetData2DOptions): Float64Array[];
 }

lib/util/getShape1D.js

@@ -18,5 +18,7 @@ "use strict";
             return new PseudoVoigt_1.PseudoVoigt(shapeOptions);
-        default:
+        default: {
+            const unHandled = kind;
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            throw new Error(`getShape1D: unknown shape kind: ${kind}`);
+            throw Error(`Unknown distribution ${unHandled}`);
+        }
     }
@@ -23,0 +25,0 @@ }

lib/util/getShape2D.js

@@ -12,5 +12,7 @@ "use strict";
             return new Gaussian2D_1.Gaussian2D(shapeOptions);
-        default:
+        default: {
+            const unHandled = kind;
             // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            throw new Error(`getShape2D: unknown shape kind: ${kind}`);
+            throw Error(`Unknown distribution ${unHandled}`);
+        }
     }
@@ -17,0 +19,0 @@ }

package.json

 {
   "name": "ml-peak-shape-generator",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Generate various peak shapes",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

src/index.ts

@@ -10,1 +10,7 @@ export * as gaussian from './shapes/1d/gaussian/Gaussian';
 export * from './shapes/2d/Shape2D';
+
+export type { XYNumber } from './shapes/2d/gaussian2D/Gaussian2D';
+export type { GaussianClassOptions } from './shapes/1d/gaussian/Gaussian';
+export type { LorentzianClassOptions } from './shapes/1d/lorentzian/Lorentzian';
+export type { PseudoVoigtClassOptions } from './shapes/1d/pseudoVoigt/PseudoVoigt';
+export type { Gaussian2DClassOptions } from './shapes/2d/gaussian2D/Gaussian2D';

src/shapes/1d/lorentzian/Lorentzian.ts

@@ -14,7 +14,2 @@ import { ROOT_THREE } from '../../../util/constants';
   fwhm?: number;
-  /**
-   * The halft width between the inflection points or standard deviation.
-   * If it is defined the fwhm would be re-assigned.
-   */
-  sd?: number;
 }
@@ -21,0 +16,0 @@

src/shapes/2d/gaussian2D/Gaussian2D.ts

@@ -6,4 +6,2 @@ import { GAUSSIAN_EXP_FACTOR } from '../../../util/constants';
 
-export { widthToFWHM, fwhmToWidth } from '../../1d/gaussian/Gaussian';
-
 export interface XYNumber {
@@ -14,3 +12,5 @@ x: number;
 
-export interface Gaussian2DOptions {
+export { widthToFWHM, fwhmToWidth } from '../../1d/gaussian/Gaussian';
+
+export interface Gaussian2DClassOptions {
   /**
@@ -33,3 +33,3 @@ * The maximum z value of the shape
 
-export interface GetDataOptions extends Gaussian2DOptions {
+export interface GetDataOptions extends Gaussian2DClassOptions {
   /**
@@ -74,3 +74,3 @@ * number of points along an specific axis.
 
-  public constructor(options: Gaussian2DOptions = {}) {
+  public constructor(options: Gaussian2DClassOptions = {}) {
     super();
@@ -77,0 +77,0 @@ let { fwhm = 50, sd, height } = options;

src/shapes/2d/Shape2D.ts

 import { XYNumber } from './gaussian2D/Gaussian2D';
 
-export interface GetDat2DOptions {
+export interface GetData2DOptions {
   length?: number | XYNumber;
@@ -18,3 +18,3 @@ factor?: number | XYNumber;
   abstract getFactor(area?: number): number;
-  abstract getData(options: GetDat2DOptions): Float64Array[];
+  abstract getData(options: GetData2DOptions): Float64Array[];
 }

src/util/getShape1D.ts

@@ -21,6 +21,8 @@ import { Gaussian } from '../shapes/1d/gaussian/Gaussian';
       return new PseudoVoigt(shapeOptions);
-    default:
+    default: {
+      const unHandled: never = kind;
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      throw new Error(`getShape1D: unknown shape kind: ${kind}`);
+      throw Error(`Unknown distribution ${unHandled}`);
+    }
   }
 }

src/util/getShape2D.ts

@@ -15,6 +15,8 @@ import { Gaussian2D } from '../shapes/2d/gaussian2D/Gaussian2D';
       return new Gaussian2D(shapeOptions);
-    default:
+    default: {
+      const unHandled: never = kind;
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      throw new Error(`getShape2D: unknown shape kind: ${kind}`);
+      throw Error(`Unknown distribution ${unHandled}`);
+    }
   }
 }

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

128820

increased by0.97%

Lines of code

2357

increased by0.51%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes