Similify - a CubeTon Product

BB Bot Version

Similify is a versatile JavaScript package designed to simplify and enhance similarity comparisons in various contexts. Whether you're comparing words, objects, arrays, or exploring string lengths and numerical ranges, Similify provides an easy-to-use interface with customizable thresholds. Effortlessly find the most similar instances and match percentages, making complex comparisons a breeze. Streamline your similarity analysis and unlock new possibilities with Similify.

Installation

1npm install similify

Usage

Require Similify in your JavaScript file and start using its functions:

Compare Words

1const { compareWords } = require('similify');
2
3// Example usage with default threshold (70)
4const result = compareWords("apple", "orange");
5console.log(result);
6// Output: { mostSimilar: 'orange', matchPercentage: 71.43 }  

Word to Object in Array Comparison

1const { wordToObjectArrayComparison } = require('similify');
2
3const objectsArray = [{ name: "banana" }, { name: "orange" }];
4
5const result = wordToObjectArrayComparison("apple", objectsArray, "name");
6console.log(result);
7// Output: { mostSimilar: 'orange', matchPercentage: 71.43 }  

Compare Objects

1const { compareObjects } = require('similify');
2
3// Example usage with default threshold (70)
4const result = compareObjects({ a: 1, b: 2 }, { a: 1, b: 3 });
5console.log(result);
6// Output: { mostSimilar: '{"a":1,"b":2}', matchPercentage: 71.43 }  

Compare Array Places

1const { compareArrayPlaces } = require('similify');
2
3const array1 = ["apple", "banana"];
4const array2 = ["orange", "banana"];
5
6const result = compareArrayPlaces(array1, 0, array2, 1);
7console.log(result);
8// Output: { mostSimilar: 'banana', matchPercentage: 71.43 }  

Compare Word to Array

1const { compareWordToArray } = require('similify');
2
3const word = "apple";
4const array = ["orange", "banana", "grape"];
5
6const result = compareWordToArray(word, array);
7console.log(result);
8// Output: { mostSimilar: 'grape', matchPercentage: 57.14 }  

Compare Arrays

1const { compareArrays } = require('similify');
2
3const array1 = ["apple", "banana"];
4const array2 = ["orange", "banana", "grape"];
5
6const result = compareArrays(array1, array2);
7console.log(result);
8// Output: { mostSimilar: ['banana'], matchPercentage: 66.67 }  

Compare String Length

1const { compareStringLength } = require('similify');
2
3const result = compareStringLength("apple", "orange");
4console.log(result);
5// Output: { longerString: 'orange', lengthDifference: 1 }  

Compare Number to Range

1const { compareNumberToRange } = require('similify');
2
3const result = compareNumberToRange(25, 20, 30);
4console.log(result);
5// Output: { withinRange: true, deviationFromMidpoint: 2.5 }  

Below are explanations for each function provided by the Similify package:

compareWords(word1, word2, threshold = 70)

This function compares two words, word1 and word2, by calculating the similarity percentage based on letter matching. The default threshold is set to 70, and the function returns an object with the most similar word and the match percentage.

wordToObjectArrayComparison(word, objectArray, key, threshold = 70)

This function compares a word to the values of a specified key within an array of objects (objectArray). It calculates the similarity percentage for each value and returns an object containing the most similar object instance and the corresponding match percentage.

compareObjects(obj1, obj2, threshold = 70)

Compares two objects (obj1 and obj2) by converting them to JSON strings and then calculating the similarity percentage based on letter matching. The default threshold is set to 70, and the function returns an object with the most similar object and the match percentage.

compareArrayPlaces(array1, index1, array2, index2, threshold = 70)

Compares two elements at specified indices (index1 and index2) within two arrays (array1 and array2). It calculates the similarity percentage based on letter matching and returns an object with the most similar element and the match percentage. The default threshold is set to 70.

compareWordToArray(word, array, threshold = 70)

Compares a word to each element in an array (array). It calculates the similarity percentage for each element and returns an object with the most similar element and the match percentage. The default threshold is set to 70.

compareArrays(array1, array2, threshold = 70)

Compares each element in two arrays (array1 and array2). It calculates the similarity percentage for each pair of elements and returns an object with the most similar elements and the match percentage. The default threshold is set to 70.

compareStringLength(str1, str2)

Compares the lengths of two strings (str1 and str2). It returns an object with the longer string and the absolute difference in length between the two strings.

compareNumberToRange(number, min, max)

Checks if a number is within a specified range (min to max). It returns an object with a boolean indicating whether the number is within the range and the deviation of the number from the midpoint of the range.

These functions provide a variety of comparison functionalities, allowing users to find similarities in words, objects, arrays, string lengths, and numerical ranges. Users can also customize the threshold for similarity based on their specific requirements.

Support

For support and discussions, join our Telegram channel: CubeTon

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.