insection - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "insection",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A data structure for storing number intervals",
@@ -5,0 +5,0 @@ "main": "lib/insection.js",

README.md

@@ -81,2 +81,26 @@ # Insection
 
+### constructor
+
+Creates a new insection instance.
+
+Signature:
+
+```js
+new Insection(); => new Insection(defaultValueComparer);
+new Insection(valueComparer);
+```
+
+where `defaultValueComparer` is:
+
+```js
+function defaultValueComparer(x, y) {
+    if (x < y) { return -1; }
+    if (x > y) { return 1; }
+    return 0;
+}
+```
+
+Values is required to have a total order, if you values does not
+support the comparison operators you can specify a valueComparer.
+
 ### add
@@ -91,6 +115,10 @@
 insection.add(start, end, value) => insection.add('[', start, end, ']', value);
-insection.add('[', start, end, ']', value) => insection.add(Insection.interval('[', start, end, ']'), value);
-insection.add('[', start, end, ')', value) => insection.add(Insection.interval('[', start, end, ')'), value);
-insection.add('(', start, end, ']', value) => insection.add(Insection.interval('(', start, end, ']'), value);
-insection.add('(', start, end, ')', value) => insection.add(Insection.interval('(', start, end, ')'), value);
+insection.add('[', start, end, ']', value) =>
+  insection.add(Insection.interval('[', start, end, ']'), value);
+insection.add('[', start, end, ')', value) =>
+  insection.add(Insection.interval('[', start, end, ')'), value);
+insection.add('(', start, end, ']', value) =>
+  insection.add(Insection.interval('(', start, end, ']'), value);
+insection.add('(', start, end, ')', value) =>
+  insection.add(Insection.interval('(', start, end, ')'), value);
 insection.add(interval, value);
@@ -150,6 +178,10 @@ ```
 insection.getIntervals(start, end) => insection.getIntervals('[', start, end, ']');
-insection.getIntervals('[', start, end, ']') => insection.getIntervals(Insection.interval('[', start, end, ']'));
-insection.getIntervals('[', start, end, ')') => insection.getIntervals(Insection.interval('[', start, end, ')'));
-insection.getIntervals('(', start, end, ']') => insection.getIntervals(Insection.interval('(', start, end, ']'));
-insection.getIntervals('(', start, end, ')') => insection.getIntervals(Insection.interval('(', start, end, ')'));
+insection.getIntervals('[', start, end, ']') =>
+  insection.getIntervals(Insection.interval('[', start, end, ']'));
+insection.getIntervals('[', start, end, ')') =>
+  insection.getIntervals(Insection.interval('[', start, end, ')'));
+insection.getIntervals('(', start, end, ']') =>
+  insection.getIntervals(Insection.interval('(', start, end, ']'));
+insection.getIntervals('(', start, end, ')') =>
+  insection.getIntervals(Insection.interval('(', start, end, ')'));
 insection.getIntervals(interval);
@@ -171,3 +203,7 @@ ```
 expect(insection.getIntervals('(', -Infinity, 2, ')').map(String).sort(), 'to equal', ['[0;4]']);
-expect(insection.getIntervals(2).map(String).sort(), 'to equal', ['[0;4]', '[2;Infinity)', '[2;Infinity)']);
+expect(insection.getIntervals(2).map(String).sort(), 'to equal', [
+  '[0;4]',
+  '[2;Infinity)',
+  '[2;Infinity)'
+]);
 ```
@@ -183,6 +219,10 @@ ### getEntries
 insection.getEntries(start, end) => insection.getEntries('[', start, end, ']');
-insection.getEntries('[', start, end, ']') => insection.getEntries(Insection.interval('[', start, end, ']'));
-insection.getEntries('[', start, end, ')') => insection.getEntries(Insection.interval('[', start, end, ')'));
-insection.getEntries('(', start, end, ']') => insection.getEntries(Insection.interval('(', start, end, ']'));
-insection.getEntries('(', start, end, ')') => insection.getEntries(Insection.interval('(', start, end, ')'));
+insection.getEntries('[', start, end, ']') =>
+  insection.getEntries(Insection.interval('[', start, end, ']'));
+insection.getEntries('[', start, end, ')') =>
+  insection.getEntries(Insection.interval('[', start, end, ')'));
+insection.getEntries('(', start, end, ']') =>
+  insection.getEntries(Insection.interval('(', start, end, ']'));
+insection.getEntries('(', start, end, ')') =>
+  insection.getEntries(Insection.interval('(', start, end, ')'));
 insection.getEntries(interval);
@@ -213,6 +253,10 @@ ```
 insection.contains(start, end) => insection.contains('[', start, end, ']');
-insection.contains('[', start, end, ']') => insection.contains(Insection.interval('[', start, end, ']'));
-insection.contains('[', start, end, ')') => insection.contains(Insection.interval('[', start, end, ')'));
-insection.contains('(', start, end, ']') => insection.contains(Insection.interval('(', start, end, ']'));
-insection.contains('(', start, end, ')') => insection.contains(Insection.interval('(', start, end, ')'));
+insection.contains('[', start, end, ']') =>
+  insection.contains(Insection.interval('[', start, end, ']'));
+insection.contains('[', start, end, ')') =>
+  insection.contains(Insection.interval('[', start, end, ')'));
+insection.contains('(', start, end, ']') =>
+  insection.contains(Insection.interval('(', start, end, ']'));
+insection.contains('(', start, end, ')') =>
+  insection.contains(Insection.interval('(', start, end, ')'));
 insection.contains(interval);
@@ -244,6 +288,10 @@ ```
 insection.remove(start, end, value) => insection.remove('[', start, end, ']', value);
-insection.remove('[', start, end, ']', value) => insection.remove(Insection.interval('[', start, end, ']'), value);
-insection.remove('[', start, end, ')', value) => insection.remove(Insection.interval('[', start, end, ')'), value);
-insection.remove('(', start, end, ']', value) => insection.remove(Insection.interval('(', start, end, ']'), value);
-insection.remove('(', start, end, ')', value) => insection.remove(Insection.interval('(', start, end, ')'), value);
+insection.remove('[', start, end, ']', value) =>
+  insection.remove(Insection.interval('[', start, end, ']'), value);
+insection.remove('[', start, end, ')', value) =>
+  insection.remove(Insection.interval('[', start, end, ')'), value);
+insection.remove('(', start, end, ']', value) =>
+  insection.remove(Insection.interval('(', start, end, ']'), value);
+insection.remove('(', start, end, ')', value) =>
+  insection.remove(Insection.interval('(', start, end, ')'), value);
 insection.remove(interval, value);
@@ -250,0 +298,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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

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

87001

increased by30.28%

Number of package files

17

increased by6.25%

Lines of code

1704

increased by48.17%

Number of lines in readme file

367

increased by15.05%

Worsened metrics

Number of low supply chain risk alerts

2

increased byInfinity%

No dependency changes