@akadenia/helpers 1.2.2 → 1.4.1

package/README.MD

@@ -22,6 +22,7 @@
   - [`TextHelpers.convertCamelToSnakeCase(data)`](#texthelpersconvertcameltosnakecasedata)
   - [`TextHelpers.convertCamelToKebabCase(data)`](#texthelpersconvertcameltokebabcasedata)
   - [`TextHelpers.convertKebabToCamelCase(data)`](#texthelpersconvertkebabtocamelcasedata)
+  - [`TextHelpers.generateAcronym(term)`](#texthelpersgenerateacronymterm)
   - [`TextHelpers.isAcronym(data)`](#texthelpersisacronymdata)
   - [`TextHelpers.acronymToKebabCase(data)`](#texthelpersacronymtokebabcasedata)
   - [`TextHelpers.handleNullDisplay(value, defaultValue="N/A")`](#texthelpershandlenulldisplayvalue-defaultvaluena)
@@ -239,6 +240,15 @@ Arguments
 |--|--|--|--|
 |`data`|`string`|The word needed to be converted from kebab case to camel case|
 
+## `TextHelpers.generateAcronym(term)`
+
+Generate an acronym from a term
+an acronym generated from the term
+
+Arguments
+|Name|Type|Required|Description|
+|--|--|--|--|
+|`term`|`string`|The term to be converted to an acronym|
 
 ## `TextHelpers.isAcronym(data)`
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { convertCamelToSnakeCase, convertSnakeToCamelCase, fileNameFromPath, formatPosition, handleNullDisplay, pluralizeOnCondition, replaceSpacesWithUnderscore, replaceUnderscoreWithSpaces, truncateText, uuidv4, enforceCharacterLimit, capitalizeText, generateIDFromWord, generateWordFromId, convertCamelToKebabCase, convertKebabToCamelCase, isAcronym, acronymToKebabCase } from "./text";
+import { convertCamelToSnakeCase, convertSnakeToCamelCase, fileNameFromPath, formatPosition, handleNullDisplay, pluralizeOnCondition, replaceSpacesWithUnderscore, replaceUnderscoreWithSpaces, truncateText, uuidv4, enforceCharacterLimit, capitalizeText, generateIDFromWord, generateWordFromId, convertCamelToKebabCase, convertKebabToCamelCase, generateAcronym, isAcronym, acronymToKebabCase } from "./text";
 import * as DateHelpers from "./date";
 import * as ObjectHelpers from "./object";
 import * as MapHelpers from "./map";
@@ -19,6 +19,7 @@ declare const TextHelpers: {
     capitalizeText: typeof capitalizeText;
     convertCamelToKebabCase: typeof convertCamelToKebabCase;
     convertKebabToCamelCase: typeof convertKebabToCamelCase;
+    generateAcronym: typeof generateAcronym;
     isAcronym: typeof isAcronym;
     acronymToKebabCase: typeof acronymToKebabCase;
     generateIDFromWord: typeof generateIDFromWord;

package/dist/index.js

@@ -50,6 +50,7 @@ const TextHelpers = {
     capitalizeText: text_1.capitalizeText,
     convertCamelToKebabCase: text_1.convertCamelToKebabCase,
     convertKebabToCamelCase: text_1.convertKebabToCamelCase,
+    generateAcronym: text_1.generateAcronym,
     isAcronym: text_1.isAcronym,
     acronymToKebabCase: text_1.acronymToKebabCase,
     generateIDFromWord: text_1.generateIDFromWord,

package/dist/text.d.ts

@@ -82,6 +82,12 @@ export declare function convertCamelToKebabCase(word: string): string;
  * @returns {string} - The word returned as camel case
  */
 export declare function convertKebabToCamelCase(word: string): string;
+/**
+ * Generate acronym from text
+ * @param term term to be converted to an acronym
+ * @returns an acronym generated from the term
+ */
+export declare function generateAcronym(term: string): string;
 /**
  * Validate if a word is acronym
  * @function

package/dist/text.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateWordFromId = exports.generateIDFromWord = exports.isValidEmail = exports.enforceCharacterLimit = exports.capitalizeText = exports.handleNullDisplay = exports.acronymToKebabCase = exports.isAcronym = exports.convertKebabToCamelCase = exports.convertCamelToKebabCase = exports.convertCamelToSnakeCase = exports.convertSnakeToCamelCase = exports.pluralizeOnCondition = exports.replaceUnderscoreWithSpaces = exports.replaceSpacesWithUnderscore = exports.fileNameFromPath = exports.truncateText = exports.formatPosition = exports.uuidv4 = exports.convertKeyCasing = void 0;
+exports.generateWordFromId = exports.generateIDFromWord = exports.isValidEmail = exports.enforceCharacterLimit = exports.capitalizeText = exports.handleNullDisplay = exports.acronymToKebabCase = exports.isAcronym = exports.generateAcronym = exports.convertKebabToCamelCase = exports.convertCamelToKebabCase = exports.convertCamelToSnakeCase = exports.convertSnakeToCamelCase = exports.pluralizeOnCondition = exports.replaceUnderscoreWithSpaces = exports.replaceSpacesWithUnderscore = exports.fileNameFromPath = exports.truncateText = exports.formatPosition = exports.uuidv4 = exports.convertKeyCasing = void 0;
 const _1 = require("./");
 // Internal Helper Functions At The Top
 /**
@@ -156,6 +156,18 @@ function convertKebabToCamelCase(word) {
         .join("");
 }
 exports.convertKebabToCamelCase = convertKebabToCamelCase;
+/**
+ * Generate acronym from text
+ * @param term term to be converted to an acronym
+ * @returns an acronym generated from the term
+ */
+function generateAcronym(term) {
+    return term
+        .split(" ")
+        .map((word) => word[0])
+        .join("");
+}
+exports.generateAcronym = generateAcronym;
 /**
  * Validate if a word is acronym
  * @function

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.2.2",
+  "version": "1.4.1",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",