quri - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.js

@@ -110,36 +110,26 @@ 'use strict';
           return 'eq';
-          break;
         case '!=':
         case 'neq':
           return 'neq';
-          break;
         case '>':
         case 'gt':
           return 'gt';
-          break;
         case '>=':
         case 'gte':
           return 'gte';
-          break;
         case '<':
         case 'lt':
           return 'lt';
-          break;
         case '<=':
         case 'lte':
           return 'lte';
-          break;
         case 'in':
           return 'in';
-          break;
         case 'not_in':
         case 'nin':
           return 'nin';
-          break;
         case 'like':
           return 'like';
-          break;
         case 'between':
           return 'between';
-          break;
       }
@@ -146,0 +136,0 @@ }

package.json

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

README.md

@@ -14,13 +14,37 @@ # quri-js
 ```sh
-npm i -D quri-js
+npm i -D quri
 ```
 
+## QURI Spec
+
+More information about the QURI specification and parser is available [here](https://github.com/theHarvester/QURI).
+
 ## Usage
 
+Basic example
+
 ```js
-import quriJs from "quri-js"
+import Criteria from "../src/index.js";
 
-quriJs() // true
+let criteria = new Criteria();
+
+criteria.toString(); // "field_1".eq("my value")
 ```
 
+Nested example
+
+```js
+let criteria = new Criteria();
+criteria.appendExpression('field_1', '==', 'outer');
+
+let nestedCriteria = new Criteria('or');
+nestedCriteria.appendExpression('field_2', 'like', 'nested%');
+nestedCriteria.appendExpression('field_3', 'in', [1,2,3,4]);
+
+criteria.appendCriteria(nestedCriteria);
+
+criteria.toString();
+// "field_1".eq("outer"),("field_2".eq("nested%")|"field_3".in(1,2,3,4))
+```
+
 ## License
@@ -27,0 +51,0 @@

No alert changes

Improved metrics

Total package byte prevSize

9142

increased by5.32%

Number of lines in readme file

66

increased by57.14%

Worsened metrics

Lines of code

123

decreased by-7.52%

No dependency changes