Advance-compare-lists NPM

advance-compare-lists

advance-compare-lists is a lightweight JavaScript utility for comparing two lists with various options such as case sensitivity, whitespace handling, special character removal, sorting, and output formatting. It works in both Node.js and browser environments.

📌 Features

Compare two lists to find unique and common elements
Supports case sensitivity and whitespace trimming
Optionally ignores special characters
Provides results in JSON, CSV, or plain text format
Works in Node.js and browsers
Lightweight and easy to use

🚀 Installation

For Node.js

npm install advance-compare-lists

For Browsers

You can include the script directly in your HTML:

<script src="https://cdn.jsdelivr.net/npm/advance-compare-lists@1.0.0/index.js"></script>

📖 Usage

1️⃣ In Node.js

const ListCompare = require("advance-compare-lists");

const options = {
    caseSensitive: false,
    ignoreWhitespace: true,
    ignoreSpecialChars: true,
    sortResults: true,
    exportFormat: "json"
};

const listCompare = new ListCompare(options);

const listA = ["apple", "banana", "cherry"];
const listB = ["banana", "cherry", "date"];

const result = listCompare.compare(listA, listB);
console.log(result);

Output:

{
  "only_in_a": ["apple"],
  "only_in_b": ["date"],
  "in_both": ["banana", "cherry"]
}

2️⃣ In Browser (HTML & JavaScript)

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>List Compare Example</title>
</head>
<body>
    <script src="https://cdn.jsdelivr.net/npm/advance-compare-lists@1.0.0/index.js"></script>
    <script>
        const listCompare = new ListCompare({ caseSensitive: false });
        const listA = ["apple", "banana", "cherry"];
        const listB = ["banana", "cherry", "date"];

        const result = listCompare.compare(listA, listB);
        console.log(result);
    </script>
</body>
</html>

🔧 Configuration Options

Option	Type	Default	Description
`caseSensitive`	Boolean	`true`	Whether to differentiate between uppercase and lowercase letters
`ignoreWhitespace`	Boolean	`false`	Removes whitespace before comparing
`ignoreSpecialChars`	Boolean	`false`	Removes special characters before comparing
`sortResults`	Boolean	`false`	Sorts the output arrays
`exportFormat`	String	`json`	Output format: `json`, `csv`, or `text`

📝 License

This project is licensed under the MIT License.

🤝 Contributing

Feel free to submit issues or pull requests to improve this package!

📬 Support

For any questions or suggestions, open an issue on GitHub.

💡 Made with ❤️ by Text Compare

compare lists tool datasets inventory textual information

1.0.0

4 months ago