Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhar2254/string-utils
A npm package for adding useful string prototypes to Node.js
https://github.com/bhar2254/string-utils
Last synced: 25 days ago
JSON representation
A npm package for adding useful string prototypes to Node.js
- Host: GitHub
- URL: https://github.com/bhar2254/string-utils
- Owner: bhar2254
- License: gpl-3.0
- Created: 2024-11-21T14:43:32.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T16:54:14.000Z (about 1 month ago)
- Last Synced: 2024-12-10T18:20:11.300Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@bhar2254/string-utils
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# string-utils
> This package was generated by ChatGPT 4o mini.
A lightweight utility library that extends JavaScript's `String.prototype` with powerful and convenient methods for string manipulation.
## Installation
Install the package using NPM:
```bash
npm install @bhar2254/string-utils
```
## Usage
To load the custom string methods:
```javascript
const { loadStringPrototypes } = require('@bhar2254/string-utils');
// Load custom prototypes
loadStringPrototypes();
// Now you can use the extended String.prototype methods!
console.log("hello world".toCamelCase()); // "helloWorld"
console.log("hello_world".replaceUnderscoreWith(' ')); // "hello world"
```
## Methods
### **Case Transformation**
#### `toCamelCase()`
Converts a string to camelCase.
```javascript
console.log("hello_world example".toCamelCase()); // "helloWorldExample"
```
#### `toSnakeCase()`
Converts a string to snake_case.
```javascript
console.log("helloWorld example".toSnakeCase()); // "hello_world_example"
```
#### `toKebabCase()`
Converts a string to kebab-case.
```javascript
console.log("helloWorld example".toKebabCase()); // "hello-world-example"
```
---
### **Truncation**
#### `truncate(length)`
Truncates a string to the specified length and appends `...` if truncated.
```javascript
console.log("This is a long string".truncate(10)); // "This is..."
```
---
### **Validation**
#### `isPalindrome()`
Checks if a string is a palindrome (ignores case, spaces, and punctuation).
```javascript
console.log("racecar".isPalindrome()); // true
console.log("A man, a plan, a canal: Panama".isPalindrome()); // true
```
#### `containsOnlyLetters()`
Checks if a string contains only alphabetical characters.
```javascript
console.log("HelloWorld".containsOnlyLetters()); // true
console.log("Hello123".containsOnlyLetters()); // false
```
---
### **Formatting**
#### `pad(length, char = ' ')`
Pads a string to the specified length with a given character (default: space).
```javascript
console.log("hello".pad(10, '-')); // "--hello---"
```
#### `reverse()`
Reverses the string.
```javascript
console.log("example".reverse()); // "elpmaxe"
```
---
### **Word Manipulation**
#### `wordCount()`
Counts the number of words in a string.
```javascript
console.log("hello world this is a test".wordCount()); // 6
```
#### `capitalize()`
Alias for `capitalizeFirst`. Capitalizes the first character of the string.
```javascript
console.log("hello world".capitalize()); // "Hello world"
```
#### `capitalizeFirst()`
Capitalizes the first character of the string.
```javascript
console.log("hello world".capitalizeFirst()); // "Hello world"
```
#### `capitalizeWords()`
Capitalizes the first letter of each word.
```javascript
console.log("hello world".capitalizeWords()); // "Hello World"
```
---
### **Customizations**
#### `removeVowels()`
Removes all vowels from the string.
```javascript
console.log("hello world".removeVowels()); // "hll wrld"
```
#### `replaceSpacesWith(char)`
Replaces all spaces with the specified character.
```javascript
console.log("hello world".replaceSpacesWith('-')); // "hello-world"
```
#### `replaceUnderscoreWith(char)`
Replaces all underscores with the specified character.
```javascript
console.log("hello_world".replaceUnderscoreWith(' ')); // "hello world"
```
#### `stripHtml()`
Removes all HTML tags from the string.
```javascript
console.log("
Hello World
".stripHtml()); // "Hello World"
```
---
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any new features, bug fixes, or improvements.
## License
This package is licensed under the GPL-3.0 license. See the [LICENSE](LICENSE) file for details.
---
Feel free to modify or extend this as needed for your specific project. 🚀