1.0.4 • Published 5 months ago
basic_node_utils v1.0.4
Basic Node Utils
A collection of basic utility functions for Node.js to make development easier and more efficient.
📦 Installation
npm install basic_node_utils
or with yarn:
yarn add basic_node_utils
🚀 Usage
const { capitalize, isEmpty, debounce, throttle, deepClone, randomInt, toKebabCase, uniqueArray, isEqual } = require('basic_node_utils');
// Capitalize
console.log(capitalize("hello world")); // Output: Hello world
// Check if empty
console.log(isEmpty([])); // Output: true
console.log(isEmpty("text")); // Output: false
// Random Integer
console.log(randomInt(1, 100)); // Output: Random number between 1 and 100
// Convert to kebab-case
console.log(toKebabCase("Hello World Example")); // Output: hello-world-example
// Unique Array
console.log(uniqueArray([1, 2, 2, 3, 4, 4])); // Output: [1, 2, 3, 4]
// Deep Clone
const obj = { a: 1, b: { c: 2 } };
const clonedObj = deepClone(obj);
console.log(clonedObj); // Output: { a: 1, b: { c: 2 } }
// Deep Compare
console.log(isEqual({ a: 1 }, { a: 1 })); // Output: true
console.log(isEqual({ a: 1 }, { b: 1 })); // Output: false
📚 Available Functions
Function | Description |
---|---|
capitalize(str) | Capitalizes the first letter of a string. |
isEmpty(value) | Checks if a string, array, or object is empty. |
debounce(func, delay) | Debounces a function by the specified delay. |
throttle(func, limit) | Throttles function execution to once every limit ms. |
deepClone(obj) | Deep clones an object or array. |
randomInt(min, max) | Generates a random integer between min and max. |
toKebabCase(str) | Converts a string to kebab-case. |
uniqueArray(arr) | Returns an array with unique values. |
isEqual(obj1, obj2) | Performs a deep comparison between two objects. |
🐛 Reporting Issues
If you encounter any bugs or issues, please open an issue.
🛠 Contributing
- Fork the repository.
- Clone your fork:
git clone https://github.com/Soundar6385/Basic_Node_Utils.git
- Create a new branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m "Add your feature"
- Push to your fork:
git push origin feature/your-feature-name
- Open a Pull Request 🚀
📄 License
This project is licensed under the MIT License.
---
### 🚀 **Steps to Push to GitHub**
1. **Initialize Git (if not done):**
```bash
git init
Add remote repository:
git remote add origin https://github.com/Soundar6385/Basic_Node_Utils.git
Commit and push:
git add . git commit -m "Initial commit with utilities and README" git push -u origin main