@akadenia/helpers 1.5.0 → 1.7.0

package/README.MD

@@ -29,8 +29,10 @@
   - [`TextHelpers.enforceCharacterLimit({text, characterLimit, onCharacterLimit})`](#texthelpersenforcecharacterlimittext-characterlimit-oncharacterlimit)
   - [`TextHelpers.isValidEmail(email)`](#texthelpersisvalidemailemail)
   - [`TextHelpers.generateIdFromWord(word)`](#texthelpersgenerateidfromwordword)
-  - [`TextHelpers.generateWordFromId(id)`](#texthelpersgeneratewordfromidid)
-  - [`TextHelpers.generateSlugFromWords(id,words)`](#texthelpersgenerateslugfromwordsidwords)
+  - [`TextHelpers.generateWordFromId(word)`](#texthelpersgeneratewordfromidword)
+  - [`TextHelpers.generateSlugFromWords(id, ...words)`](#texthelpersgenerateslugfromwordsid-words)
+  - [`TextHelpers.extractIDfromSlug(slug)`](#texthelpersextractidfromslugslug)
+  - [`TextHelpers.abbreviateNumber(number)`](#texthelpersabbreviatenumbernumber)
 - [ObjectHelpers](#objecthelpers)
   - [`ObjectHelpers.isPureObject(any)`](#objecthelpersispureobjectany)
   - [`ObjectHelpers.parseCookie(str)`](#objecthelpersparsecookiestr)
@@ -38,13 +40,15 @@
   - [`ObjectHelpers.containsSubObject(mainObject, subObject)`](#objecthelperscontainssubobjectmainobject-subobject)
   - [`ObjectHelpers.findObjectBySubObject(array, subObject)`](#objecthelpersfindobjectbysubobjectarray-subobject)
   - [`ObjectHelpers.filterObjectsBySubObject(array, subObject)`](#objecthelpersfilterobjectsbysubobjectarray-subobject)
-  - [`ObjectHelpers.objectPropHasValue({object, key, value)}`](#objecthelpersobjectkeyhasvalueobject-key-value)
+  - [`ObjectHelpers.objectPropHasValue({object, key, value)}`](#objecthelpersobjectprophasvalueobject-key-value)
   - [`ObjectHelpers.findEntry(array, predicate)`](#objecthelpersfindentryarray-predicate)
 - [GenericHelpers](#generichelpers)
   - [`GenericHelpers.delay(ms)`](#generichelpersdelayms)
   - [`GenericHelpers.getPreferredUriScheme(host)`](#generichelpersgetpreferredurischemehost)
 - [FileHelpers](#filehelpers)
   - [`FileHelpers.checkFileExtension(filePath, validExtensions)`](#filehelperscheckfileextensionfilepath-validextensions)
+  - [Contributing to this package](#contributing-to-this-package)
+  - [License](#license)
 
 # DateHelpers
 
@@ -261,7 +265,6 @@ Arguments
 |--|--|--|--|
 |`data`|`string`|The word that is being validated as acronym|
 
-
 ## `TextHelpers.acronymToKebabCase(data)`
 
 Convert acronym to kebab case
@@ -272,7 +275,6 @@ Arguments
 |--|--|--|--|
 |`data`|`string`|The acronym to be converted to kebab case|
 
-
 ## `TextHelpers.handleNullDisplay(value, defaultValue="N/A")`
 
 Returns the input string or the default string if the input value is null or undefined.
@@ -324,7 +326,7 @@ Arguments
 ## `TextHelpers.generateSlugFromWords(id, ...words)`
 
 Get the slug from words
-Returns the slug from the words  and it will be url path safe
+Returns the slug from the words and it will be url path safe
 
 Arguments
 |Name|Type|Required|Description|
@@ -343,6 +345,22 @@ Arguments
 |--|--|--|--|
 |`slug`|`string`|`true`|The slug associated with the id|
 
+## `TextHelpers.abbreviateNumber(number)`
+
+Returns the string representation of the abbreviated number, rounded to two decimal places.
+
+Arguments
+|Name|Type|Required|Description|
+|--|--|--|--|
+|`number`|`number`|`true`|The number to be abbreviated|
+
+Examples
+- Numbers below 1,000 are displayed without abbreviation
+- Numbers between 1,000 and 1,000,000 are displayed in thousands (e.g. 1.23K)
+- Numbers between 1,000,000 and 1,000,000,000 are displayed in millions (e.g. 1.23M)
+- Numbers above 1,000,000,000 are displayed in billions (e.g. 1.23B)
+
+Note: If the input `number` is null or undefined, the function returns null.
 
 # ObjectHelpers
 
@@ -425,7 +443,9 @@ Arguments
 |--|--|--|--|
 |`array`|`T[]`|`true`|An array of objects to be filtered|
 |`array`|`Partial<T>`|`true`|The sub-object to be searched for in the array|
+
 ## `ObjectHelpers.objectPropHasValue({object, key, value)}`
+
 Checks if the object has the key with the value.
 
 Arguments
@@ -436,6 +456,7 @@ Arguments
 |`value`|`any`|`true`|The value to check|
 
 ## `ObjectHelpers.findEntry(array, predicate)`
+
 Finds the first entry in the array that satisfies the predicate.
 
 Arguments
@@ -480,7 +501,6 @@ Arguments
 |`filePath`|`string`|`true`|The file path to check|
 |`validExtensions`|`string[]`|`true`|The valid extensions|
 
-
 ## Contributing to this package
 
 This package follows the commitlint and conventional commits standards. As such the commit messages should follow the following format:

package/dist/text.d.ts

@@ -165,3 +165,10 @@ export declare function generateSlugFromWordsWithID(id: string, ...words: string
  * @returns The id from the slug
  */
 export declare function extractIDfromSlug(slug: string): string | undefined;
+/**
+ * Abbreviate number
+ * @function
+ * @param number The number to be abbreviated
+ * @returns The string representation of the abbreviated number
+ */
+export declare const abbreviateNumber: (number: number | undefined | null) => string | null;

package/dist/text.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractIDfromSlug = exports.generateSlugFromWordsWithID = 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;
+exports.abbreviateNumber = exports.extractIDfromSlug = exports.generateSlugFromWordsWithID = 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
 /**
@@ -292,3 +292,25 @@ function extractIDfromSlug(slug) {
     return slug.split("-").pop();
 }
 exports.extractIDfromSlug = extractIDfromSlug;
+/**
+ * Abbreviate number
+ * @function
+ * @param number The number to be abbreviated
+ * @returns The string representation of the abbreviated number
+ */
+const abbreviateNumber = (number) => {
+    const abbreviations = [
+        { value: 1e9, symbol: "B" },
+        { value: 1e6, symbol: "M" },
+        { value: 1e3, symbol: "K" },
+    ];
+    if (!number || isNaN(number))
+        return null;
+    const abbreviated = abbreviations.find(({ value }) => Math.abs(number) >= value);
+    if (abbreviated) {
+        const { value, symbol } = abbreviated;
+        return (number / value).toFixed(2).replace(/\.00$/, "") + symbol;
+    }
+    return number.toString();
+};
+exports.abbreviateNumber = abbreviateNumber;

package/package.json

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