UTILS-REUSE

Project information

• Name: Utils
• Version: 1

Setting up local environment

Running the app

# development
# start dev env
$ npm run dev

Test

# unit tests
$ npm run test

Quick Guide

Common Function

import { CommonUtils }  from 'utils-bl';

const utils = new CommonUtils();

// getProp -  Verifies if property exists and returns value.
/**
 * Verifies if property exists and returns value.
 *
 * Usage: getProp({a: { b: { c: 1 }}, 'a.b.c') => 1
 *
 * @param {object} o
 * @param {string} props object path
 * @param {*} defaultValue value returned if property does not exist
 *
 * @returns the value o
 */
const object = {
  attrOne: '1',
  attrTwo: 2,
  attrThree: '3',
  attrFive: {
    A: 'A',
    B: 'B',
  },
};

it('Should return property of object', async () => {
  const result: any = utils.getProp(object, 'attrTwo', '');
  expect(result).toStrictEqual(object.attrTwo);
});

// generateUUId - Generate the unique id
/**
 * Generate the unique id
 * @returns {string} a unique id
 */
it('Should return property of object', async () => {
  const result: any = utils.generateUUId();
  expect(result).toBeDefined();
});

// convertToCurrency - Convert a Number to a Currency
/**
 * Convert a Number to a Currency
 * @param {*} num — The number to format.
 * @param {*} currency - The currency to format to — The default is set to “USD”
 * @param {*} locale - The default is set to “en-US”
 * @returns {string} value after convert
 */
it('Should return string "€ 100,00"', async () => {
  const result: any = utils.convertToCurrency(100, 'EUR', 'nl-NL');
  expect(result).toHaveLength(8);
});

// refer link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat

// measurePerformance - Measure the Performance of a Function
/**
 * Measure the Performance of a Function
 * @param {*} name — The name of the label is displayed in the console.
 * @param {*} fn - The function you want to measure the performance of
 * @param {*} args - The arguments for the function you’re calling
 * @returns {string} time fuction took to execute
 */
it('Should return property of object', async () => {
  const result: any = utils.measurePerformance();
  expect(result).toBeDefined();
});

// removeDuplicates -Remove Duplicates From an Array except object
/**
 *  Remove Duplicates From an Array
 * @param {*} array — input array list.
 * @returns {array} new array after remove duplicates
 */
it('Should return array [1,"1",2,3,4]', async () => {
  const array: any = [1, '1', 1, 2, 3, 4];
  const result: any = utils.removeDuplicates(array);
  expect(result).toStrictEqual([1, '1', 2, 3, 4]);
});

Logger module

Print log message to console, or record it as file

import { LogsUtils }  from 'utils-bl';
let logLevel = process.env.LOG_LEVEL; // if process.env.LOG_LEVEL undefined logLevel default value is 'info'

// set config init log module
/**
 * @param {*} componentName — define name intance log.
 * @param {*} level — level log expect to display.
 * @param {*} console — print logs to console.
 * @param {*} record — record logs to files.
 * @param {*} extras — extras params.
 */
log.initEnv( componentName: string, level?: string, console?: boolean, record?: boolean, extras?: Array<any>);

// sample
log.initEnv('log-test', 'info', true, false);

log.debug(`Testing logger debug`);
log.info(`Testing logger info ${ JSON.stringify({logLevel: logLevel, LOG_LEVEL: process.env.LOG_LEVEL})}`);
log.warning(`Testing logger warning`);
log.error(`Testing logger error`);
log.fatal(`Testing logger fatal`);
log.access(`Testing logger access`);

---

- Author - [Binh Le]

## License

[MIT licensed](LICENSE).