# @thimpat/libutils > Helper functions Latest version **1.18.1** (published 2023-08-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @thimpat/libutils pnpm add @thimpat/libutils yarn add @thimpat/libutils bun add @thimpat/libutils ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.18.1 | | Published | 2023-08-28 | | First published | 2022-06-08 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 131.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Patrice Thimothee | | Maintainers | thimpat | ## Links - npm: https://www.npmjs.com/package/@thimpat/libutils - Repository: https://github.com/thimpat/libutils - Homepage: https://github.com/thimpat/libutils#readme - Issues: https://github.com/thimpat/libutils/issues - npm.io page: https://npm.io/package/@thimpat/libutils ## Recent versions - 1.18.1 (latest) — 2023-08-28 - 1.18.0 — 2023-08-28 - 1.17.0 — 2023-02-21 - 1.16.0 — 2023-01-22 - 1.15.8 — 2023-01-02 - 1.15.7 — 2023-01-02 - 1.15.6 — 2023-01-02 - 1.15.5 — 2023-01-02 - 1.15.4 — 2023-01-02 - 1.15.3 — 2023-01-02 - 1.15.1 — 2022-12-30 - 1.15.0 — 2022-12-30 - 1.14.0 — 2022-12-30 - 1.13.6 — 2022-12-25 - 1.13.5 — 2022-12-22 - … 37 more at https://npm.io/package/@thimpat/libutils/versions ## README [![Test workflow](https://github.com/thimpat/libutils/actions/workflows/test.yml/badge.svg)](https://github.com/thimpat/libutils/actions/workflows/test.yml) [![Version workflow](https://github.com/thimpat/libutils/actions/workflows/versioning.yml/badge.svg)](https://github.com/thimpat/libutils/actions/workflows/versioning.yml) ## Description A library containing utility functions working in both ESM and CJS (+ some in the browser when compatible):
--- ## Installation ```shell npm install @thimpat/libutils ```
--- ## Usage ### CJS ```javascript const {...} = require("@thimpat/libutils"); ```
### ESM ```javascript import {...} from "@thimpat/libutils"; ```
--- ## Helpers
#### normalisePath * Convert paths by replacing backward slashes "\" with forward slashes "/" * Always keeps the last "/" for directories ```javascript normalisePath("C:\\some\\where\\here") // C:/some/where/here ```
--- #### joinPath * Join paths following the conventions above (normalisePath) ```javascript joinPath("aaa", "vvv") // ./aaa/vvv joinPath("aaa", "vvv/") // ./aaa/vvv/ ```
--- #### isConventionalFolder ###### If source finishes with a "/", it's a folder, otherwise, it's not. ```javascript isConventionalFolder("C:\\some\\where\\here\\") // true ```
--- #### resolvePath ###### Resolve path ```javascript isConventionalFolder("\\where\\here\\") // /home/user/some/where/here/ ```
--- #### getAppDataDir ###### Returns OS data dir for the application
--- #### sleep ###### Delay code execution for a number of milliseconds ```javascript await sleep(5000); // 5 seconds ```
--- #### convertStringArgumentToArray ###### Convert a string into an argument list ```javascript // ["/Users/me/Chrome SxS/Application/chrome.exe", "--my-errors", "--aa=true"]; convertStringArgumentToArray("'/Users/me/Chrome SxS/Application/chrome.exe' --my-errors --aa=true"); ```
--- #### convertToUrl ```javascript convertToUrl({protocol, host, port, pathname}) convertToUrl({host: "localhost", port: 8877}) // http://localhost:8877/ convertToUrl({protocol: "https", host: "localhost", port: 8877}) // https://localhost:8877/ convertToUrl({protocol: "https", host: "somewhere"}) // https://somewhere/ convertToUrl({protocol: "https", host: "somewhere", pathname: "here"}) // https://somewhere/here ```
--- #### areEquals ###### Compare two inputs (Objects, Arrays, etc.) ```javascript areEquals(15, "d"); // false areEquals([1, 2, 3],[1, 2, 3]); // true areEquals([1, 2, 3],[1, 3, 2]); // false areEquals({aa: 1, bb: 2, cc: 3}, {aa: 1, bb: 2, cc: 3}); // true areEquals({aa: 1, bb: 2, cc: 3}, {cc: 3, bb: 2, aa: 1}); // true areEquals({aa: 1, bb: 2, cc: 3}, {aa: 0, bb: 2, cc: 3}); // false // true areEquals( [{ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, {ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}], [{ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, {ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}], ) // true areEquals( {ff: 6, ee: [1, 2, 3, "ewe", [{ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, {ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}]], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, {ff: 6, ee: [1, 2, 3, "ewe", [{ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, {ff: 6, ee: [1, 2, 3, "ewe", "dfdf"], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}]], dd: 4, cc: [1, 2, 3, "ewe", "dfdf"], bb: 2, aa: 1}, ); ```
--- #### calculateRelativePath ###### Calculate path to another path from a source
--- #### calculateCommon ###### Returns the longest common directory amongst a list of files and folders ```javascript calculateCommon(["/a/b/c/d", "/a/b/c/d/e", "/a/b/c/d/e/g/h/i"]); // => "/a/b/c/" ```
--- #### getPackageJson > NEEDS REVIEW. NOT PRODUCTION READY. Returns package.json content ```javascript // CJS and ESM const packageJson = getPackageJson() ``` ```javascript // Take project name into account const packageJson = getPackageJson({projectname: "myproject"}) ``` ```javascript // Find project root even if the current working directory is within a module // if pwd === /home/user/projs/project1/node_modules/some_modules/ const packageJson = getPackageJson({root: true}) // Content of /home/user/projs/project1/package.json const packageJson = getPackageJson({root: false}) // Content of /home/user/projs/project1/node_modules/some_modules/package.json ``` > ###### _* Default value for "root" is false_
--- #### getLocalIp ###### Try to best guess the machine local IP ```javascript getLocalIp() // 192.168.1.4 ```
--- #### simplifyObject ###### Remove circular references from an object ```javascript const obj1 = {a: 1, b: 2}; const obj2 = {}; obj1.c = obj2; obj2.d = obj1; const obj = simplifyObject(obj1); // {a:1, b:2, c: {d: "[circular reference]" }} ```
--- ### Package ``` 📁 package │ └───📝 lib-utils.cjs ⇽ CJS version - Node (43.7k unminified) └───📝 lib-utils.mjs ⇽ ESM version - Node (43.1k unminified) │ └───📁 dist │ │ │ │ 📝 lib-utils.mjs ⇽ ESM version - Browser (18.6k unminified) │ │ 📝 lib-utils.min.mjs ⇽ ESM version - Browser (9.4k minified) ```
--- ### Changelog ##### current: * Add existInJson function ##### 1.17.0: * Add functions getAppTempDir() and createAppTempDir() ##### 1.16.0: * Add functions isDirectory, isFile and isSymbolicLink ##### 1.15.8: * Fix clone function when source is falsy ##### 1.15.6: * Fix normaliseFileName function (tested) ##### 1.15.5: * Fix normaliseFileName function ##### 1.15.4: * Review error message for obsolete functions * Restore function [normaliseFileName] ##### 1.15.0: * Remove two obsolete functions: convertSessionToArg & convertSessionKeyNameToArg * Add function clone * Add functions getHashFromText and getHashFromFile ##### 1.14.0: * Add function convertStringArgumentToArray * Add function convertSingleCommandLineArgumentToArray ##### 1.13.6: * Fix areEquals changing the content type for arrays of objects ##### 1.13.5: * Remove incompatible functions from browser library ##### 1.13.4: * Allow symlinks in normaliseRealPathV2 ##### 1.12.2: * Fix simplifyObject misnaming ##### 1.12.1: * Make simplifyObject immutable (bug) * Do not mutate the object passed to simplifyObject ##### 1.12.0: * Add the function simplifyObject ##### 1.11.0: * Add function convertStringArgumentToArray ##### 1.10.4: * Make the function isItemInList() obsolete (The function was meant to be more expressive, but libutils is becoming more generic) - Use JavaScript built in [].includes() instead ##### 1.10.0: * areEquals() to compare two variables (Objects, Arrays, etc.) ##### 1.9.4: * Make non-generic function getGlobalArguments obsolete ##### 1.9.3: * Review some minor output for the commonDir function ##### 1.9.2: * Fix calculateCommon function --- --- _Source: https://npm.io/package/@thimpat/libutils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._