@mhmdhammoud/meritt-utils 1.0.4 → 1.0.5

package/ReleaseNotes.md

@@ -1,5 +1,22 @@
 # Changes
 
+## Version 1.0.5
+
+### Added
+
+- Added toUpperTitle method that accepts a string and removes all non alphanumeric characters and capitalizes each letter of every first word
+
+```typescript
+import {Formatter} from '@mhmdhammoud/meritt-utils'
+
+// Usage Example
+const sentence:string = "hello__world$$99"
+console.log(Formatter.toUpperTitle(sentence))
+
+console : Hello World 99
+
+```
+
 ## Version 1.0.4
 
 ### Added
@@ -41,9 +58,7 @@ const slug = Formatter.slugify('My Product Name') // my-product-name
 ### Fixes and Improvements
 
 - Fixed bug in Crypto class where encrypting a string with a key that is not a number would throw an error
-
 - Improved Crypto class to allow encrypting and decrypting numbers and objects
-
 - Documented Crypto class
 
 ## Version 1.0.2

package/dist/lib/formatter.d.ts

@@ -28,6 +28,18 @@ declare class Formatter {
      * ```
      * */
     obfuscate: (email: string) => string;
+    /**
+     * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+     * @param sentence - The input sentence to be processed.
+     * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+     * @example
+     * ```typescript
+     * const sentence = 'this is34354345a---sentence'
+     * const newSentence = ToUpperTitle(sentence)
+     * console.log(newSentence) // 'This Is A Sentence'
+     * ```
+     */
+    toUpperTitle: (sentence: string) => string;
     /**
      * @remarks Generates a slug from a given string
      * @param title - string to be converted to slug

package/dist/lib/formatter.js

@@ -78,6 +78,32 @@ class Formatter {
                 email.slice(2, separatorIndex).replace(/./g, '*') +
                 email.slice(separatorIndex));
         };
+        /**
+         * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+         * @param sentence - The input sentence to be processed.
+         * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+         * @example
+         * ```typescript
+         * const sentence = 'this is34354345a---sentence'
+         * const newSentence = ToUpperTitle(sentence)
+         * console.log(newSentence) // 'This Is A Sentence'
+         * ```
+         */
+        this.toUpperTitle = (sentence) => {
+            if (typeof sentence !== 'string')
+                throw new Error('Provide a valid string');
+            if (!sentence)
+                throw new Error('Provide a valid string');
+            const sanitizedSentence = sentence.replace(/[^a-zA-Z0-9]+/g, ' ');
+            const words = sanitizedSentence.split(' ');
+            const capitalizedWords = [];
+            for (let i = 0; i < words.length; i++) {
+                const word = words[i];
+                const capitalizedWord = word.charAt(0).toUpperCase() + word.slice(1);
+                capitalizedWords.push(capitalizedWord);
+            }
+            return capitalizedWords.join(' ');
+        };
         /**
          * @remarks Generates a slug from a given string
          * @param title - string to be converted to slug

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mhmdhammoud/meritt-utils",
-	"version": "1.0.4",
+	"version": "1.0.5",
 	"description": "",
 	"main": "./dist/index.js",
 	"private": false,
@@ -21,9 +21,6 @@
 		"lint": "eslint src --fix",
 		"prepublish": "npm run build"
 	},
-	"dependencies": {
-		"dotenv": "^10.0.0"
-	},
 	"devDependencies": {
 		"ts-node-dev": "^1.1.8",
 		"typescript": "^4.6.3",

package/src/lib/formatter.ts

@@ -16,7 +16,7 @@ class Formatter {
 	 * // => 'Hello-World'
 	 * ```
 	 * */
-	toUpperFirst = (_: string | number, withSpacing = true) => {
+	toUpperFirst = (_: string | number, withSpacing = true): string => {
 		if (typeof _ !== 'string') throw new Error('Provide a valid string')
 		if (withSpacing) {
 			return _.split(' ')
@@ -79,6 +79,34 @@ class Formatter {
 		)
 	}
 
+	/**
+	 * Capitalizes the first letter of each word in a sentence and removes non-alphanumeric characters.
+	 * @param sentence - The input sentence to be processed.
+	 * @returns A new sentence with the first letter of each word capitalized and non-alphanumeric characters removed.
+	 * @example
+	 * ```typescript
+	 * const sentence = 'this is34354345a---sentence'
+	 * const newSentence = ToUpperTitle(sentence)
+	 * console.log(newSentence) // 'This Is A Sentence'
+	 * ```
+	 */
+	toUpperTitle = (sentence: string): string => {
+		if (typeof sentence !== 'string') throw new Error('Provide a valid string')
+		if (!sentence) throw new Error('Provide a valid string')
+
+		const sanitizedSentence = sentence.replace(/[^a-zA-Z0-9]+/g, ' ')
+		const words = sanitizedSentence.split(' ')
+		const capitalizedWords = []
+
+		for (let i = 0; i < words.length; i++) {
+			const word = words[i]
+			const capitalizedWord = word.charAt(0).toUpperCase() + word.slice(1)
+			capitalizedWords.push(capitalizedWord)
+		}
+
+		return capitalizedWords.join(' ')
+	}
+
 	/**
 	 * @remarks Generates a slug from a given string
 	 * @param title - string to be converted to slug