@cepharum/concrete-db 0.1.2-alpha.1 → 0.2.0

package/lib/term-functions.mjs

@@ -56,32 +56,43 @@ export function compare( left, right ) {
 }
 
 /**
- * Extracts list of terms from provided scalar or non-scalar value.
+ * Extracts list of words from provided scalar or non-scalar value.
  *
- * A term is a consecutive sequence of letters and digits. On setting custom
- * option for ignoring case, all letters of collected terms are converted to
- * lowercase in resulting map.
+ * A word is a consecutive sequence of letters, digits, underscores and dashes
+ * though dashes are rejected in a leading position. On setting custom option
+ * for ignoring case, all letters of collected words are converted to lowercase
+ * in resulting map.
  *
- * @param {any} value value to extract terms from
- * @param {number} minSize minimum number of characters in a string to be considered for extracting terms
- * @param {number} minTermSize minimum number of characters in extracted terms
- * @param {number} maxTermSize maximum number of characters in extracted terms
- * @param {boolean} ignoreCase set true to drop case of extracted terms
+ * @param {any} value value to extract words from
+ * @param {number} minSize minimum number of characters in a string to be considered for extracting words
+ * @param {number} minWordSize minimum number of characters in extracted words
+ * @param {number} maxWordSize maximum number of characters in extracted words
+ * @param {boolean} ignoreCase set true to drop case of extracted words
  * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
- * @returns {Object<string,number>} map of extracted terms into either term's number of occurrences
+ * @returns {Object<string,number>} map of extracted words into either words's number of occurrences
  */
-export function terms( value, minSize = 10, minTermSize = 1, maxTermSize = Infinity, ignoreCase = false, strict = true ) {
+export function spread( value, minSize = 10, minWordSize = 3, maxWordSize = Infinity, ignoreCase = true, strict = true ) {
 	const result = {};
 
-	for ( const term of generateTerms( value, minSize, ignoreCase, strict ) ) {
-		if ( term.length >= minTermSize && term.length <= maxTermSize ) {
-			result[term] = ( result[term] || 0 ) + 1;
+	for ( const word of generateWords( value, minSize, ignoreCase, strict ) ) {
+		if ( word.length >= minWordSize && word.length <= maxWordSize ) {
+			result[word] = ( result[word] || 0 ) + 1;
 		}
 	}
 
 	return result;
 }
 
+/**
+ * Generates error with provided message for failing curing process.
+ *
+ * @param {string} message description of error
+ * @returns {Error} generated error
+ */
+export function fail( message ) {
+	return new Error( message );
+}
+
 
 /**
  * Recursively iterates over provided source converting all scalar data into
@@ -93,7 +104,7 @@ export function terms( value, minSize = 10, minTermSize = 1, maxTermSize = Infin
  * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
  * @returns {Generator<string|*, void, *>} iterator over flat sequence of terms
  */
-function *generateTerms( source, minSize, ignoreCase, strict ) {
+function *generateWords( source, minSize, ignoreCase, strict ) {
 	let stream;
 
 	if ( Array.isArray( source ) ) {
@@ -124,6 +135,6 @@ function *generateTerms( source, minSize, ignoreCase, strict ) {
 	}
 
 	for ( const sub of stream ) {
-		yield* generateTerms( sub, minSize, ignoreCase, strict );
+		yield* generateWords( sub, minSize, ignoreCase, strict );
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cepharum/concrete-db",
-	"version": "0.1.2-alpha.1",
+	"version": "0.2.0",
 	"description": "a read-only web database generator",
 	"main": "lib/collector.mjs",
 	"types": "concrete-db.d.ts",
@@ -25,7 +25,7 @@
 		"lodash.merge": "^4.6.2",
 		"minimist": "^1.2.6",
 		"promise-essentials": "^0.2.0",
-		"simple-terms": "^0.3.3",
+		"simple-terms": "^0.4.0",
 		"yaml": "^2.1.0"
 	},
 	"devDependencies": {