Merge branch 'dev' of https://github.com/terminusdb/terminus-client into dev

Author: Francesca-Bit

lib/woql.js

@@ -25,6 +25,8 @@ WOQL.when = function(Query, Update){ return new WOQLQuery().when(Query, Update);
 /**
  * The Query in the Optional argument is specified as optional
  * @param {object} query - WOQL Query object
+ * @example
+ * WOQL.opt(WOQL.triple("v:optionalSubject", "v:optionalObject", "v:optionalValue"))
  * @return {object} WOQLQuery
  */
 WOQL.opt = function(query){ return new WOQLQuery().opt(query); }
@@ -69,21 +71,49 @@ WOQL.start = function(start, query){ return new WOQLQuery().start(start, query);
 WOQL.select = function(...list){ return new WOQLQuery().select(...list); }
 
 /**
- * Creates a logical OR of the arguments
+ * Filter the query so only those triples that match any of the subqueries are included
  * @param queries - WOQL Query objects
  * @return {object} WOQLQuery
+ *
+ *
+ * @example
+ * // find triples that are of type scm:Journey, and have
+ * // a start_station v:Start, and that start_station is labeled
+ * // v:Start_Label
+ *
+ * WOQL.and(
+ *      WOQL.triple("v:Journey", "type", "scm:Journey"),
+ *      WOQL.or(
+ *          WOQL.triple("v:Journey", "scm:start_station", "doc:Station31007"),
+ *          WOQL.triple("v:Journey", "scm:start_station", "doc:Station31114")),
+ *      WOQL.triple("v:Journey", "scm:start_station", "v:Start"),
+ *      WOQL.triple("v:Start", "label", "v:Start_Label"))
+ *
+ * @see WOQLQuery().woql_or for WOQL.py version of the same function
  */
 WOQL.or = function(...queries){	return new WOQLQuery().or(...queries); }
 
 /**
- * Creates a logical AND of the arguments
+ * Filter the query so only those triples that match all of the subqueries are included
  * @param queries - WOQL Query objects
  * @return {object} WOQLQuery
+ *
+ * @example
+ * // find triples that are of type scm:Journey, and have
+ * // a start_station v:Start, and that start_station is labeled
+ * // v:Start_Label
+ *
+ * WOQL.and(
+ *      WOQL.triple("v:Journey", "type", "scm:Journey"),
+ *      WOQL.triple("v:Journey", "start_station", "v:Start"),
+ *      WOQL.triple("v:Start", "label", "v:Start_Label"))
+ *
+ * @see WOQLQuery().woql_and for WOQL.py version of the same function
  */
 WOQL.and = function(...queries){ return new WOQLQuery().and(...queries); }
 
 /**
- * Creates a logical NOT of the arguments
+ * Include only triples that do not match the single contained query
  * @param queries - WOQL Query objects
  * @return {object} WOQLQuery
  */