@synatic/noql - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

lib/canQuery.js

@@ -137,2 +137,6 @@ const _allowableFunctions = require('./MongoFunctions');
 
+/**
+ *
+ * @param expr
+ */
 function isAllowableType(expr) {
@@ -139,0 +143,0 @@ if (expr.type === 'function' && expr.args) {

lib/make/getParsedValueFromBinaryExpression.js

@@ -10,3 +10,3 @@ const _allowableFunctions = require('../MongoFunctions');
  * @param {import('../types').Expression} expressionPart - the expression to turn into a value
- * @param {function} [groupByColumnParserFn] - the group by parser function passed to manage group by clauses
+ * @param {Function} [groupByColumnParserFn] - the group by parser function passed to manage group by clauses
  * @param {number} [depth] - the depth of the expression allowing for dynamic field names
@@ -59,3 +59,3 @@ * @returns {string|undefined|*}
  * @param {import('../types').Expression} expr - the ast expression
- * @param {function} [groupByColumnParserFn] - the group by parser function passed to manage group by clauses
+ * @param {Function} [groupByColumnParserFn] - the group by parser function passed to manage group by clauses
  * @param {number} [depth] - the depth of the expression allowing for dynamic field names
@@ -62,0 +62,0 @@ * @returns {*}

lib/make/groupByColumnParser.js

@@ -13,2 +13,6 @@ const _allowableFunctions = require('../MongoFunctions');
 
+/**
+ *
+ * @param column
+ */
 function getAggrFunctionsForColumn(column) {
@@ -15,0 +19,0 @@ const potentialFuncs = [];

lib/SQLParser.js

@@ -11,2 +11,18 @@ const {parseSQLtoAST} = require('./parseSQLtoAST');
     /**
+     * The version of the parser
+     *
+     * @type {string}
+     * @readonly
+     * @static
+     * @memberof SQLParser
+     * @example
+     * const {SQLParser} = require('@synatic/noql);
+     * console.log(SQLParser.VERSION);
+     * // 2.0.2
+     */
+    static get VERSION() {
+        return require('../package.json').version;
+    }
+
+    /**
      * Parses sql to either a query or aggregate
@@ -17,2 +33,14 @@ *
      * @returns {import('./types').ParsedQueryOrAggregate}
+     * @throws
+     * @memberof SQLParser
+     * @example
+     * const {SQLParser} = require('@synatic/noql');
+     * const sql = 'SELECT * FROM users WHERE age > 18';
+     * const parsed = SQLParser.parseSQL(sql);
+     * console.log(parsed);
+     * // {
+     * //   collection: 'users',
+     * //   query: { age: { $gt: 18 } },
+     * //   projection: { _id: 0 },
+     * // }
      */
@@ -19,0 +47,0 @@ static parseSQL(sql, options = {}) {

package.json

 {
   "name": "@synatic/noql",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Convert SQL statements to mongo queries or aggregates",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -29,3 +29,3 @@ # NoQL - Not Only SQL
         await client.connect();
-        const db = client.db('sql-to-mongo-test');
+        const db = client.db('noql-test');
 
@@ -32,0 +32,0 @@ const parsedSQL = SQLParser.parseSQL('select id from `films` limit 10');

No alert changes

Improved metrics

Total package byte prevSize

220116

increased by0.37%

Lines of code

5136

increased by0.71%

No dependency changes