@raju0090/string-utilities
Version:
`stringUtils` is a simple utility module that provides functions for common string operations.
88 lines (63 loc) • 2.49 kB
Markdown
# stringUtils Module
`stringUtils` is a simple utility module that provides functions for common string operations. You can use these functions to manipulate and check strings easily. The module includes the following functions:
- **reverse**: Reverse a given string.
- **toUpperCase**: Convert a string to uppercase.
- **toLowerCase**: Convert a string to lowercase.
- **isPalindrome**: Check if a string is a palindrome (ignores non-alphanumeric characters and case).
## Installation
1. Install the module via npm:
```bash
npm install @raju0090/string-utilities
```
## Functions
### 1. `reverse(str)`
Reverses the given string.
**Parameters:**
- `str` (string): The string you want to reverse.
**Returns:**
- A new string with the characters reversed.
**Example:**
```js
const stringUtils = require('./stringUtils');
console.log(stringUtils.reverse("hello")); // Output: "olleh"
```
### 2. `toUpperCase(str)`
Converts the given string to uppercase.
**Parameters:**
- `str` (string): The string you want to convert to uppercase.
**Returns:**
- A new string that is the uppercase version of the input string.
**Example:**
```js
console.log(stringUtils.toUpperCase("hello")); // Output: "HELLO"
```
### 3. `toLowerCase(str)`
Converts the given string to lowercase.
**Parameters:**
- `str` (string): The string you want to convert to lowercase.
**Returns:**
- A new string that is the lowercase version of the input string.
**Example:**
```js
console.log(stringUtils.toLowerCase("HELLO")); // Output: "hello"
```
### 4. `isPalindrome(str)`
Checks if a string is a palindrome, ignoring spaces, punctuation, and case.
**Parameters:**
- `str` (string): The string you want to check for being a palindrome.
**Returns:**
- `true` if the string is a palindrome, otherwise `false`.
**Example:**
```js
console.log(stringUtils.isPalindrome("A man, a plan, a canal, Panama")); // Output: true
console.log(stringUtils.isPalindrome("hello")); // Output: false
```
## Example Usage
```js
const stringUtils = require('./stringUtils');
console.log(stringUtils.reverse("hello")); // Output: "olleh"
console.log(stringUtils.toUpperCase("hello")); // Output: "HELLO"
console.log(stringUtils.toLowerCase("HELLO")); // Output: "hello"
console.log(stringUtils.isPalindrome("A man, a plan, a canal, Panama")); // Output: true
console.log(stringUtils.isPalindrome("hello")); // Output: false
```