@etsoo/shared 1.0.60 → 1.0.61

package/README.md

@@ -124,8 +124,8 @@ String and other related utilities
 
 |Name|Description|
 |---:|---|
-|formatLowerLetter|Format word's first letter to lower case|
-|formatUpperLetter|Format word's first letter to upper case|
+|formatInitial|Format inital character to lower case or upper case|
+|formatString|Format string with parameters|
 |getDataChanges|Get data changed fields with input data updated|
 |getTimeZone|Get time zone|
 |joinItems|Join items as a string|

package/__tests__/Utils.ts

@@ -23,6 +23,12 @@ test('Tests for getDataChanges', () => {
     expect(input.amount).toBeUndefined();
 });
 
+test('Tests for formatInitial', () => {
+    expect(Utils.formatInitial('HelloWorld')).toBe('helloWorld');
+    expect('HelloWorld'.formatInitial(false)).toBe('helloWorld');
+    expect('hello'.formatInitial(true)).toBe('Hello');
+});
+
 test('Tests for formatString', () => {
     const template = '{0} is first item, {1} is second item, {0} repeat';
     const result = 'aa is first item, bb is second item, aa repeat';
@@ -30,14 +36,6 @@ test('Tests for formatString', () => {
     expect(template.format('aa', 'bb')).toBe(result);
 });
 
-test('Tests for formatLowerLetter', () => {
-    expect(Utils.formatLowerLetter('HelloWorld')).toBe('helloWorld');
-});
-
-test('Tests for formatUpperLetter', () => {
-    expect(Utils.formatUpperLetter('hello')).toBe('Hello');
-});
-
 test('Tests for joinItems', () => {
     expect(Utils.joinItems(['a', undefined, ' b', '', 'c '], ',')).toBe(
         'a,b,c'
@@ -55,7 +53,10 @@ test('Tests for newGUID', () => {
 });
 
 test('Tests for removeNonLetters', () => {
-    expect(Utils.removeNonLetters('1234-5678@abc.')).toBe('12345678abc');
+    const input = '1234-5678@abc.';
+    const result = '12345678abc';
+    expect(Utils.removeNonLetters(input)).toBe(result);
+    expect(input.removeNonLetters()).toBe(result);
 });
 
 test('Tests for objectEqual', () => {

package/lib/cjs/Utils.d.ts

@@ -5,9 +5,19 @@ declare global {
          * Format string
          * @param this Template
          * @param parameters Parameters to fill the template
-         * @returns Result
          */
         format(this: string, ...parameters: string[]): string;
+        /**
+         * Forat inital character
+         * @param this Input string
+         * @param upperCase To upper case or lower case
+         */
+        formatInitial(this: string, upperCase: boolean): string;
+        /**
+         * Remove non letters (0-9, a-z, A-Z)
+         * @param this Input string
+         */
+        removeNonLetters(this: string): string;
     }
 }
 /**
@@ -15,22 +25,18 @@ declare global {
  */
 export declare namespace Utils {
     /**
-     * Format word's first letter to lower case
-     * @param word Word
+     * Format inital character to lower case or upper case
+     * @param input Input string
+     * @param upperCase To upper case or lower case
      */
-    function formatLowerLetter(word: string): string;
+    function formatInitial(input: string, upperCase?: boolean): string;
     /**
-     * Format string
+     * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
      */
     function formatString(template: string, ...parameters: string[]): string;
-    /**
-     * Format word's first letter to upper case
-     * @param word Word
-     */
-    function formatUpperLetter(word: string): string;
     /**
      * Get data changed fields with input data updated
      * @param input Input data

package/lib/cjs/Utils.js

@@ -9,21 +9,30 @@ String.prototype.format = function (...parameters) {
     });
     return template;
 };
+String.prototype.formatInitial = function (upperCase = false) {
+    const initial = this.charAt(0);
+    return ((upperCase ? initial.toUpperCase() : initial.toLowerCase()) +
+        this.slice(1));
+};
+String.prototype.removeNonLetters = function () {
+    return this.replace(/[^a-zA-Z0-9]/g, '');
+};
 /**
  * Utilities
  */
 var Utils;
 (function (Utils) {
     /**
-     * Format word's first letter to lower case
-     * @param word Word
+     * Format inital character to lower case or upper case
+     * @param input Input string
+     * @param upperCase To upper case or lower case
      */
-    function formatLowerLetter(word) {
-        return word.charAt(0).toLowerCase() + word.slice(1);
+    function formatInitial(input, upperCase = false) {
+        return input.formatInitial(upperCase);
     }
-    Utils.formatLowerLetter = formatLowerLetter;
+    Utils.formatInitial = formatInitial;
     /**
-     * Format string
+     * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
@@ -32,14 +41,6 @@ var Utils;
         return template.format(...parameters);
     }
     Utils.formatString = formatString;
-    /**
-     * Format word's first letter to upper case
-     * @param word Word
-     */
-    function formatUpperLetter(word) {
-        return word.charAt(0).toUpperCase() + word.slice(1);
-    }
-    Utils.formatUpperLetter = formatUpperLetter;
     /**
      * Get data changed fields with input data updated
      * @param input Input data
@@ -190,9 +191,7 @@ var Utils;
      * @returns Result
      */
     Utils.removeNonLetters = (input) => {
-        if (input == null || input === '')
-            return input;
-        return input.replace(/[^a-zA-Z0-9]/g, '');
+        return input === null || input === void 0 ? void 0 : input.removeNonLetters();
     };
     /**
      * Set source with new labels
@@ -223,9 +222,9 @@ var Utils;
     Utils.snakeNameToWord = (name, firstOnly = false) => {
         const items = name.split('_');
         if (firstOnly) {
-            items[0] = formatUpperLetter(items[0]);
+            items[0] = items[0].formatInitial(true);
             return items.join(' ');
         }
-        return items.map((part) => formatUpperLetter(part)).join(' ');
+        return items.map((part) => part.formatInitial(true)).join(' ');
     };
 })(Utils = exports.Utils || (exports.Utils = {}));

package/lib/mjs/Utils.d.ts

@@ -5,9 +5,19 @@ declare global {
          * Format string
          * @param this Template
          * @param parameters Parameters to fill the template
-         * @returns Result
          */
         format(this: string, ...parameters: string[]): string;
+        /**
+         * Forat inital character
+         * @param this Input string
+         * @param upperCase To upper case or lower case
+         */
+        formatInitial(this: string, upperCase: boolean): string;
+        /**
+         * Remove non letters (0-9, a-z, A-Z)
+         * @param this Input string
+         */
+        removeNonLetters(this: string): string;
     }
 }
 /**
@@ -15,22 +25,18 @@ declare global {
  */
 export declare namespace Utils {
     /**
-     * Format word's first letter to lower case
-     * @param word Word
+     * Format inital character to lower case or upper case
+     * @param input Input string
+     * @param upperCase To upper case or lower case
      */
-    function formatLowerLetter(word: string): string;
+    function formatInitial(input: string, upperCase?: boolean): string;
     /**
-     * Format string
+     * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
      */
     function formatString(template: string, ...parameters: string[]): string;
-    /**
-     * Format word's first letter to upper case
-     * @param word Word
-     */
-    function formatUpperLetter(word: string): string;
     /**
      * Get data changed fields with input data updated
      * @param input Input data

package/lib/mjs/Utils.js

@@ -6,21 +6,30 @@ String.prototype.format = function (...parameters) {
     });
     return template;
 };
+String.prototype.formatInitial = function (upperCase = false) {
+    const initial = this.charAt(0);
+    return ((upperCase ? initial.toUpperCase() : initial.toLowerCase()) +
+        this.slice(1));
+};
+String.prototype.removeNonLetters = function () {
+    return this.replace(/[^a-zA-Z0-9]/g, '');
+};
 /**
  * Utilities
  */
 export var Utils;
 (function (Utils) {
     /**
-     * Format word's first letter to lower case
-     * @param word Word
+     * Format inital character to lower case or upper case
+     * @param input Input string
+     * @param upperCase To upper case or lower case
      */
-    function formatLowerLetter(word) {
-        return word.charAt(0).toLowerCase() + word.slice(1);
+    function formatInitial(input, upperCase = false) {
+        return input.formatInitial(upperCase);
     }
-    Utils.formatLowerLetter = formatLowerLetter;
+    Utils.formatInitial = formatInitial;
     /**
-     * Format string
+     * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
@@ -29,14 +38,6 @@ export var Utils;
         return template.format(...parameters);
     }
     Utils.formatString = formatString;
-    /**
-     * Format word's first letter to upper case
-     * @param word Word
-     */
-    function formatUpperLetter(word) {
-        return word.charAt(0).toUpperCase() + word.slice(1);
-    }
-    Utils.formatUpperLetter = formatUpperLetter;
     /**
      * Get data changed fields with input data updated
      * @param input Input data
@@ -187,9 +188,7 @@ export var Utils;
      * @returns Result
      */
     Utils.removeNonLetters = (input) => {
-        if (input == null || input === '')
-            return input;
-        return input.replace(/[^a-zA-Z0-9]/g, '');
+        return input === null || input === void 0 ? void 0 : input.removeNonLetters();
     };
     /**
      * Set source with new labels
@@ -220,9 +219,9 @@ export var Utils;
     Utils.snakeNameToWord = (name, firstOnly = false) => {
         const items = name.split('_');
         if (firstOnly) {
-            items[0] = formatUpperLetter(items[0]);
+            items[0] = items[0].formatInitial(true);
             return items.join(' ');
         }
-        return items.map((part) => formatUpperLetter(part)).join(' ');
+        return items.map((part) => part.formatInitial(true)).join(' ');
     };
 })(Utils || (Utils = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.60",
+    "version": "1.0.61",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/Utils.ts

@@ -6,9 +6,21 @@ declare global {
          * Format string
          * @param this Template
          * @param parameters Parameters to fill the template
-         * @returns Result
          */
         format(this: string, ...parameters: string[]): string;
+
+        /**
+         * Forat inital character
+         * @param this Input string
+         * @param upperCase To upper case or lower case
+         */
+        formatInitial(this: string, upperCase: boolean): string;
+
+        /**
+         * Remove non letters (0-9, a-z, A-Z)
+         * @param this Input string
+         */
+        removeNonLetters(this: string): string;
     }
 }
 
@@ -23,20 +35,36 @@ String.prototype.format = function (
     return template;
 };
 
+String.prototype.formatInitial = function (
+    this: string,
+    upperCase: boolean = false
+) {
+    const initial = this.charAt(0);
+    return (
+        (upperCase ? initial.toUpperCase() : initial.toLowerCase()) +
+        this.slice(1)
+    );
+};
+
+String.prototype.removeNonLetters = function (this: string) {
+    return this.replace(/[^a-zA-Z0-9]/g, '');
+};
+
 /**
  * Utilities
  */
 export namespace Utils {
     /**
-     * Format word's first letter to lower case
-     * @param word Word
+     * Format inital character to lower case or upper case
+     * @param input Input string
+     * @param upperCase To upper case or lower case
      */
-    export function formatLowerLetter(word: string) {
-        return word.charAt(0).toLowerCase() + word.slice(1);
+    export function formatInitial(input: string, upperCase: boolean = false) {
+        return input.formatInitial(upperCase);
     }
 
     /**
-     * Format string
+     * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
@@ -45,14 +73,6 @@ export namespace Utils {
         return template.format(...parameters);
     }
 
-    /**
-     * Format word's first letter to upper case
-     * @param word Word
-     */
-    export function formatUpperLetter(word: string) {
-        return word.charAt(0).toUpperCase() + word.slice(1);
-    }
-
     /**
      * Get data changed fields with input data updated
      * @param input Input data
@@ -233,8 +253,7 @@ export namespace Utils {
      * @returns Result
      */
     export const removeNonLetters = (input?: string) => {
-        if (input == null || input === '') return input;
-        return input.replace(/[^a-zA-Z0-9]/g, '');
+        return input?.removeNonLetters();
     };
 
     /**
@@ -279,10 +298,10 @@ export namespace Utils {
     ) => {
         const items = name.split('_');
         if (firstOnly) {
-            items[0] = formatUpperLetter(items[0]);
+            items[0] = items[0].formatInitial(true);
             return items.join(' ');
         }
 
-        return items.map((part) => formatUpperLetter(part)).join(' ');
+        return items.map((part) => part.formatInitial(true)).join(' ');
     };
 }