js-utils-prem
v1.0.3
Published
A comprehensive collection of JavaScript utility functions designed to simplify common tasks in string manipulation and array operations. Ideal for enhancing productivity and reducing repetitive code in your projects.
Downloads
21
Readme
js-utils-prem
A comprehensive collection of JavaScript utility functions designed to simplify common tasks in string manipulation and array operations. Ideal for enhancing productivity and reducing repetitive code in your projects.
Features
- String Utilities: Functions for manipulating and analyzing strings.
- Array Utilities: Functions for working with arrays, including operations like shuffling, chunking, and flattening.
Installation
You can install the package using npm:
npm install js-utils-prem
Usage
To use the utilities, import the functions you need:
```javascript
import {
reverseString,
capitalizeFirstLetter,
toCamelCase,
countWords,
isPalindrome,
randomString,
toTitleCase,
uniqueArray,
shuffleArray,
maxArray,
minArray,
removeDuplicates,
chunkArray,
flattenArray,
extractEmailDomain,
averageArray,
medianArray,
intersectArrays,
removeWhitespace,
countOccurrences
} from 'js-utils-prem';
String Utilities
- Reverses the given string
reverseString(str: string): string
reverseString('hello'); // 'olleh'
- Capitalizes the first letter of a string
capitalizeFirstLetter(str: string): string
capitalizeFirstLetter('hello'); // 'Hello'
- Converts a string to camelCase
toCamelCase(str: string): string
toCamelCase('hello_world'); // 'helloWorld'
- Counts the number of words in a string
countWords(str: string): number
countWords('hello world'); // 2
- Checks if a string is a palindrome
isPalindrome(str: string): boolean
isPalindrome('racecar'); // true
- Generates a random string of a given length
randomString(length: number): string
randomString(8); // 'aBcDeFgH' (example output; actual output may vary)
- Converts a string to title case
toTitleCase(str: string): string
toTitleCase('hello world'); // 'Hello World'
- Extracts the domain from an email address
extractEmailDomain(email: string): string | null
extractEmailDomain('[email protected]'); // 'example.com'
Array Utilities
- Finds unique elements in an array
uniqueArray(arr: any[]): any[]
uniqueArray([1, 2, 2, 3]); // [1, 2, 3]
- Shuffles an array
shuffleArray(arr: any[]): any[]
shuffleArray([1, 2, 3]); // [2, 3, 1] (example output; actual output may vary)
- Finds the maximum value in an array
maxArray(arr: number[]): number
maxArray([1, 2, 3]); // 3
- Finds the minimum value in an array
minArray(arr: number[]): number
minArray([1, 2, 3]); // 1
- Removes duplicates from an array
removeDuplicates(arr: any[]): any[]
removeDuplicates([1, 1, 2, 3]); // [1, 2, 3]
- Chunks an array into smaller arrays of a specified size
chunkArray(arr: any[], size: number): any[][]
chunkArray([1, 2, 3, 4], 2); // [[1, 2], [3, 4]]
- Flattens a nested array
flattenArray(arr: any[]): any[]
flattenArray([1, [2, [3, [4]]]]); // [1, 2, 3, 4]
Contributing
Contributions are welcome! Please review the contributing guidelines for details on how to contribute.
Contact
For any questions or suggestions, please open an issue or contact the author at [email protected].