quri - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

dist/index.js

@@ -7,8 +7,8 @@ 'use strict';
 
-var _Quri = require('./Quri');
+var _quri = require('./quri');
 
-var _Quri2 = _interopRequireDefault(_Quri);
+var _quri2 = _interopRequireDefault(_quri);
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-exports.default = _Quri2.default;
+exports.default = _quri2.default;

package.json

 {
   "name": "quri",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "JS wrapper for the QURI string specification",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -23,8 +23,8 @@ # quri-js
 
-Basic example
+### Basic example
 
 ```js
-import quri from "quri";
+import Quri from 'quri';
 
-let quri = new quri();
+const quri = new Quri();
 
@@ -34,11 +34,15 @@ quri.toString(); // "field_1".eq("my value")
 
-Nested example
+### Nested example
 
 ```js
-let quri = new quri();
+import Quri from 'quri';
+
+const quri = new Quri();
+
 quri.appendExpression('field_1', '==', 'outer');
 
-let nestedQuri = new quri('or');
+const nestedQuri = new Quri('or');
+
 nestedQuri.appendExpression('field_2', 'like', 'nested%');
-nestedQuri.appendExpression('field_3', 'in', [1,2,3,4]);
+nestedQuri.appendExpression('field_3', 'in', [1, 2, 3, 4]);
 
@@ -51,2 +55,43 @@ quri.appendCriteria(nestedQuri);
 
+### Serialization
+
+```js
+import Quri from 'quri';
+
+let quri = new Quri();
+
+quri.appendExpression('field_1', '==', 'my value');
+
+quri.toJS();
+// { criteria: [ [ 'field_1', '==', 'my value' ] ] }
+quri.toJS({ verbose: true });
+// { conjunction: 'and', criteria: [ { field: 'field_1', operator: '==', value: 'my value' } ] }
+quri.conjunction
+// and
+quri.criteria
+// [ { field: 'field_1', operator: '==', value: 'my value' } ]
+
+quri = Quri.fromJS({ criteria: [ [ 'field_1', '==', 'my value' ] ] })
+quri.toString();
+// "field_1".eq("my value")
+
+quri = Quri.fromJS({ criteria: [ { field: 'field_1', operator: '==', value: 'my value' } ] });
+quri.toString();
+// "field_1".eq("my value")
+
+quri = Quri.fromJS({ conjunction: 'or', criteria: [
+  [ 'field_1', '==', 'my value' ],
+  [ 'field_2', '==', 'my value 2' ]
+] })
+quri.toString();
+// "field_1".eq("my value")|"field_2".eq("my value 2")
+
+quri = Quri.fromJS({ conjunction: 'or', criteria: [
+  { field: 'field_1', operator: '==', value: 'my value' },
+  { field: 'field_2', operator: '==', value: 'my value 2' }
+] })
+quri.toString();
+// "field_1".eq("my value")|"field_2".eq("my value 2")
+```
+
 ## License
@@ -53,0 +98,0 @@

New alerts

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

Fixed alerts

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17659

increased by19.71%

Lines of code

320

increased by12.68%

Number of lines in readme file

111

increased by68.18%

Number of medium supply chain risk alerts

1

decreased by-50%

No dependency changes