Merge pull request #327 from hoijnet/issue/325-literal-value-zero

Issue/325 literal value zero which looks accurate, but adding significant test battery instead

Author: hoijnet

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
     - name: Run terminusdb server
       run: |
         docker run --detach --publish 127.0.0.1:6363:6363 terminusdb/terminusdb-server:dev && sleep 10

docs/helper/format.js

@@ -117,7 +117,7 @@ exports.isDeprecated = function () {
 exports.navItemAnchor = function () {
   if (typeof this.label === 'string') {
     const anchorName = this.label.replace(/ /g, '-');
-    return anchorName.toLowerCase();
+    return anchorName?.toLowerCase();
   }
   return this.name;
 };

lib/query/woqlBuilder.js

@@ -86,9 +86,9 @@ WOQLQuery.prototype.boolean = function (tf) {
 };
 
 /**
- * @param {any} s
- * @param {string} t
- * @returns {object}
+ * @param {any} s - the value of the literal
+ * @param {string} t - the type of the literal, e.g. 'xsd:string', 'xsd:boolean'
+ * @returns {object} - a WOQL DataValue object with the given type and value
  */
 WOQLQuery.prototype.literal = function (s, t) {
   t = t.indexOf(':') === -1 ? `xsd:${t}` : t;

lib/woql.js

@@ -312,13 +312,17 @@ WOQL.equals = function (varName, varValue) {
 };
 
 /**
- * Substring
+ * Substring of string
  * @param {string|Var} string - String or variable
  * @param {number|Var} before - integer or variable (characters from start to begin)
  * @param {number|Var} [length] - integer or variable (length of substring)
  * @param {number|Var} [after] - integer or variable (number of characters after substring)
  * @param {string|Var} [substring] - String or variable
  * @returns {WOQLQuery}
+ * @example
+ * let [after, result] = vars("after", "result")
+ * substr("joe", 1, 2, after, result)
+ * //result is "oe", after is 2
  */
 
 WOQL.substr = function (string, before, length, after, substring) {