Dynamic-Utils

Dynamic-Utils is a JavaScript utility library providing a set of functions for common operations such as dynamic case structures, file reading and processing, waiting with time units, creating shell command functions, object and array manipulations, and more.

Installation

You can install Dynamic-Utils using npm or yarn:

npm install dynamic-utils

or

yarn add dynamic-utils

Usage

Import the functions from the library as follows:

import {
  _case,
  _filetoJson,
  _wait,
  _createShellCommands,
  _forEachInObject,
  _removeDuplicates,
  _objectToArray,
  _arrayToObject
} from 'dynamic-utils';

Functions

``_case(variable, ...couples[, defaultFunc])`: Acts as a dynamic switch-case structure.

_filetoJson(path[, options, processFunction]): Reads a JSON file and converts it to a JSON object. Can take a processing function.

_wait(value, unit): Returns a Promise that resolves after the specified time.

_createShellCommands(commands): Creates an object containing functions for executing specified shell commands.

_forEachInObject(obj, callback): Iterates over the properties of an object and executes a callback for each key-value pair.

_removeDuplicates(array[, except]): Removes duplicates from an array, with an option to exclude certain values.

_objectToArray(obj): Converts an object to an array of key-value pairs, including for nested structures.

_arrayToObject(array[, keyIndex]): Converts an array of key-value pairs to an object.

_filterArray(array, ...types): Filters nested arrays following the types given as parameters.

Exemples

Below are some examples of how you can use the library functions:

Dynamic Switch Case

const variableToMatch = 'case3';
const result = _case(variableToMatch,
  ['case1', () => 'Case 1 executed'],
  ['case2', x => `Case 2 executed with value: ${x}`],
  () => 'Default case executed'
);
console.log(result); // Output: 'Default case executed'

Read and Process JSON File

// Synchronous processing
const jsonObject = _filetoJson('path/to/file.json', {}, data => processData(data));
console.log(jsonObject);

// Asynchronous processing
_filetoJson('path/to/file.json', {}, async data => {
  return await processAsync(data);
}).then(result => console.log(result));

Wait Function

_wait(10, 's').then(() => console.log('Waited 10 seconds.'));

Shell Command Execution

const gitCmds = _createShellCommands([{ 'pull': 'git pull' }, { 'status': 'git status' }]);
gitCmds.pull().then(stdout => console.log(stdout)).catch(err => console.error(err));

Iterate Over Object Properties

const myObject = { a: 10, b: 20, c: 30 };
_forEachInObject(myObject, (value, key) => {
  console.log(`Key ${key}: Value ${value}`);
});

Filter arrays with multiple types

const array =  _filterArray([1, 'hello', [2, true, 'world'], {foo: 'bar'}], 'number', 'string');
console.log(array) // Output: [1, 'hello', [2, 'world']]

Insert into array with float index

const array = [1, 2, 3, 4, 5];

console.log(_insertAt(array, 3.14, 'a', 'b', true)) // Output: [1, 2, 3, 'a', 'b', true, 4, 5]

Contributing

Contributions and feedbacks are always welcome!