@mongez/reinforcements 2.2.6 → 2.2.7

package/README.md

@@ -1361,6 +1361,7 @@ The following list defines all available string utilities
 - [Trim Left](#trimming-values-from-string): Remove a string from the beginning of the given string.
 - [Trim Right](#trimming-values-from-string): Remove a string from the end of the given string.
 - [Starts With Arabic Letter](#detect-if-string-starts-with-arabic): Detect if string starts with Arabic letter.
+- [Name Initials](#name-initials): Get the initials of the given name.
 
 ### Capitalize
 
@@ -1736,6 +1737,40 @@ console.log(startsWithArabic(string)); // false
 console.log(startsWithArabic(arabicString)); // true
 ```
 
+### Name Initials
+
+Get initials from a name.
+
+`initials(name: string, separator = ''): string`
+
+```ts
+import { initials } from "@mongez/reinforcements";
+
+const name = "John Doe";
+
+console.log(initials(name)); // JD
+```
+
+You can also pass a separator to separate the initials.
+
+```ts
+import { initials } from "@mongez/reinforcements";
+
+const name = "John Doe";
+
+console.log(initials(name, '.')); // J.D
+```
+
+If the given parameter is not a string it will throw an error.
+
+```ts
+import { initials } from "@mongez/reinforcements";
+
+const name = 123;
+
+console.log(initials(name)); // Error: The given name is not a string.
+```
+
 ## Numbers
 
 Here are the aviation numbers utilities.
@@ -2003,6 +2038,8 @@ To run tests run `npm run test` or `yarn test`
 
 ## Change Log
 
+- 2.2.7 (22 Feb 2023)
+  - Added [Name Initials](#name-initials) function.
 - 2.2.0 (08 Nov 2022)
   - Migrated Collections From Package to separate package.
 - 2.1.0 (06 Nov 2022)

package/cjs/index.d.ts

@@ -31,6 +31,7 @@ export { default as unset } from "./object/unset";
 export { default as Random } from "./Random/random";
 export { default as capitalize } from "./string/capitalize";
 export { default as extension } from "./string/extension";
+export { default as initials } from "./string/initials";
 export { default as ltrim } from "./string/ltrim";
 export { default as readMoreChars } from "./string/readMoreChars";
 export { default as readMoreWords } from "./string/readMoreWords";

package/cjs/index.js

@@ -35,6 +35,7 @@ var unset = require("./object/unset.js");
 var random = require("./Random/random.js");
 var capitalize = require("./string/capitalize.js");
 var extension = require("./string/extension.js");
+var initials = require("./string/initials.js");
 var ltrim = require("./string/ltrim.js");
 var readMoreChars = require("./string/readMoreChars.js");
 var readMoreWords = require("./string/readMoreWords.js");
@@ -90,6 +91,7 @@ exports.unset = unset;
 exports.Random = random;
 exports.capitalize = capitalize;
 exports.extension = extension;
+exports.initials = initials;
 exports.ltrim = ltrim;
 exports.readMoreChars = readMoreChars;
 exports.readMoreWords = readMoreWords;

package/cjs/object/get.js

@@ -17,7 +17,7 @@ function getValue(object, keyChain, defaultValue) {
 /**
  * Get the value of the given key
  */
-function get(object, key, defaultValue = null) {
+function get(object, key, defaultValue) {
   if (!object) return defaultValue;
   if (object[key]) return object[key];
   return getValue(object, key, defaultValue);

package/cjs/string/initials.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the initials of the given name
+ */
+export default function initials(name: string, separator?: string): string;
+//# sourceMappingURL=initials.d.ts.map

package/cjs/string/initials.js

@@ -0,0 +1,17 @@
+"use strict";
+
+/**
+ * Get the initials of the given name
+ */
+function initials(name, separator = "") {
+  if (!name) return "";
+  if (typeof name !== "string") {
+    throw new Error("The name must be a string");
+  }
+  return name
+    .split(" ")
+    .map(name => name.charAt(0))
+    .join(separator);
+}
+
+module.exports = initials;

package/esm/index.d.ts

@@ -31,6 +31,7 @@ export { default as unset } from "./object/unset";
 export { default as Random } from "./Random/random";
 export { default as capitalize } from "./string/capitalize";
 export { default as extension } from "./string/extension";
+export { default as initials } from "./string/initials";
 export { default as ltrim } from "./string/ltrim";
 export { default as readMoreChars } from "./string/readMoreChars";
 export { default as readMoreWords } from "./string/readMoreWords";

package/esm/index.js

@@ -31,6 +31,7 @@ export { default as unset } from "./object/unset.js";
 export { default as Random } from "./Random/random.js";
 export { default as capitalize } from "./string/capitalize.js";
 export { default as extension } from "./string/extension.js";
+export { default as initials } from "./string/initials.js";
 export { default as ltrim } from "./string/ltrim.js";
 export { default as readMoreChars } from "./string/readMoreChars.js";
 export { default as readMoreWords } from "./string/readMoreWords.js";

package/esm/object/get.js

@@ -15,7 +15,7 @@ function getValue(object, keyChain, defaultValue) {
 /**
  * Get the value of the given key
  */
-function get(object, key, defaultValue = null) {
+function get(object, key, defaultValue) {
   if (!object) return defaultValue;
   if (object[key]) return object[key];
   return getValue(object, key, defaultValue);

package/esm/string/initials.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get the initials of the given name
+ */
+export default function initials(name: string, separator?: string): string;
+//# sourceMappingURL=initials.d.ts.map

package/esm/string/initials.js

@@ -0,0 +1,15 @@
+/**
+ * Get the initials of the given name
+ */
+function initials(name, separator = "") {
+  if (!name) return "";
+  if (typeof name !== "string") {
+    throw new Error("The name must be a string");
+  }
+  return name
+    .split(" ")
+    .map(name => name.charAt(0))
+    .join(separator);
+}
+
+export { initials as default };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mongez/reinforcements",
-    "version": "2.2.6",
+    "version": "2.2.7",
     "description": "A lightweight package to give a massive reinforcements to variant types of data in Nodejs/Javascript",
     "main": "./cjs/index.js",
     "dependencies": {