@satheeshpolu/utils-package NPM

Reusable Code Package

This Package contains a collection of reusable core functions designed to simplify common programming tasks.

Installalation

Navigate to the root directory of your project using the terminal or command prompt. Then run npm i @satheeshpolu/utils-package
This process will download and install the most recent version of the @satheeshpolu/utils-package package into your project.
Reference link https://www.npmjs.com/package/@satheeshpolu/utils-package

Reusable core functions

The package includes the following functions:

S.No	Functions	Paramerter(s)	Default Values	Possible Values
1	formatNumber(number)	*number*: Number`required`	NA	Number: `+ve or -ve number`
2	formatDate(date, delimiter)	*date: Date`required` delimiter* string`optional`	date= `new Date()` delimiter= `.`	delimiter: `/ or : or -`
3	sortData(data, orderType)	*data: Array[] `required` orderType*: string`optional`	data = `[]` orderType=`asc`	orderType: `des`
4	sortArrayOfObjectsByField(data, field, orderType)	*data: Array[]`required` field:object key`optional` orderType*:	data = `[]` field=`object key`orderType=`asc`	orderType: `des`

Fundamental Functions

You can make use of these fundamental functions for your convenience:

1. formatNumber():

Its purpose is to assist you in formatting a number in a specific manner. It allows you to maintain consistent and application-specific formatting for numbers.

Usage

This function allows us to prepend a leading 0 to numbers when they are less than 10.

const formattedNumber = formatNumber(number);

Note: It doesn't show any affect if the number is `-ve` or above `10`.<br>
Example(s):
   1.const formattedNumber = utilsPackage.formatNumber(9);   //Output: 09
   2.const formattedNumber = utilsPackage.formatNumber(-9);  //Output: -9
   3.const formattedNumber = utilsPackage.formatNumber(99);  //Output: 99

2. formatDate():

Its purpose is to assist in formatting date in a specific manner. This function ensures that dates are consistently displayed according to your application's requirements.

Usage
Import the this package at the top of the file as shown below. const utilsPackage = require('@satheeshpolu/utils-package');
const formattedNumber = utilsPackage.formatDate(); // output: 01.10.2023 16:39`
Example(s):
   const formattedNumber = utilsPackage.formatDate(new Date(), '/');  // Output: 01/10/2023 16:39
   const formattedNumber = utilsPackage.formatDate(new Date(), ':');  // Output: 01:10:2023 16:39
   const formattedNumber = utilsPackage.formatDate(new Date(), '-');  // Output: 01-10-2023 16:39

3. sortArray():

Its purpose is to aid in sorting data within an array.

Usage
Import the this package at the top of the file as shown below. const utilsPackage = require('@satheeshpolu/utils-package');
const formattedNumber = utilsPackage.sortArray(-1, -4, -6, 3); // Output: -6, -4, -1, 3
Example(s):
   const formattedNumber = utilsPackage..sortArray([-1, -4, -6, 3], 'des); // Output: [3, -1, -4, -6]

4. sortArrayOfObjectsByKey():

Its purpose is to assist in sorting data within an array that contains a list of objects.

Usage

Import the this package at the top of the file as shown below. const utilsPackage = require('@satheeshpolu/utils-package');

Example(s):
 const formattedNumber = utilsPackage.sortArrayOfObjectsByKey([{x: 1, y: 1}, {x: 4, y: 6}], 'x')); // Output: [ { x: 1, y: 1 }, { x: 4, y: 6 } ]
 const formattedNumber = utilsPackage.sortArrayOfObjectsByKey([{x: 1, y: 1}, {x: 4, y: 6}], 'x', 'des')); // Output: [ { x: 4, y: 6 }, { x: 1, y: 1 } ]
 const formattedNumber = utilsPackage.sortArrayOfObjectsByKey([{x: 'sam', y: 'aa'}, {x: 'ram', y: 'cc'}], 'x')); // Output: [ { x: 'ram', y: 'cc' }, { x: 'sam', y: 'aa' } ]
 const formattedNumber = utilsPackage.sortArrayOfObjectsByKey([{x: 'sam', y: 'aa'}, {x: 'ram', y: 'cc'}], 'x', 'des')); // Output: [ { x: 'sam', y: 'aa' }, { x: 'ram', y: 'cc' } ]