@veloxia/veloxia

Some javascript helper functions.

Installation

npm install @veloxia/veloxia

Import

ES6/Typescript

import * as v from "@veloxia/veloxia";

CommonJS

const v = require("@veloxia/veloxia");

Example usage

File reading and file writing

v.fw() and v.fr() provides quick access to file read/write. The helpers enforce providing the __dirname to avoid opening or writing to the wrong file. If the file extension is .json, the content is automatically encoded/decoded using JSON.stringify() and JSON.parse().

// Save an object as JSON
const obj = { name: "Hello world" };
v.fw(__dirname, "file.json", obj);

// Open the file and parse automatically
const file = v.fr(__dirname, "file.json");
console.log(file);
// => {name: 'Hello world'}

Utils

v.awaitCondition() lets you await anything.

(async () => {
  let aVariable;
  setTimeout(() => {
    aVariable = "Hello";
  }, 5000);
  console.log(aVariable);
  // => undefined
  await awaitCondition(function () {
    if(typeof aVariable !== "undefined") return true;
  }
  console.log(aVariable);
  // => "Hello"
})();

Formatting

v.numberFormat() adds thousands separators/decimal points to a number.

const val = v.numberFormat(8999.9112, 2, ",", " ");
console.log(val); // 8 999,91

Dates

v.date() applies a format template to a date object.

const now = v.date("Y-m-d");
// => 2020-06-11
const yesterday = v.date("Y-m-d", Date.now() - 1000 * 3600 * 24);
// => 2020-06-10