projectphil-utils v1.0.3

Project Phil Utilities

A simple utilities package that offers many different functions that could be of use to you when writing ExpressJS websites or Discord bots!

Functions / Exports

• figlify
• mdConvert
• generateRandom
• sanitize
• saveFile
• getDate
• fetchTime
• getRandomArray
• checkIfHex
• dirSize
• getDiscountedValue
• randomColor

figlify

Used to turn text into art!

    const utils = require('projectphil-utils');
    await utils.figlify("Hello World!", { randFont: true, font: undefined });

mdConvert

Converts raw text/md to HTML compatible.

    const utils = require('projectphil-utils');
    let text = "# Hello world!";
    let webPageContent = await utils.mdConvert(text);
    res.render('index.ejs', { content: webPageContent }); // ExpressJS Framework Example

generateRandom

Generate a random string of acceptable characters.

    const utils = require('projectphil-utils');
    let random = await utils.generateRandom(12) // How long the string should be
    console.log(random);

sanitize

Make a string of text MySQL compatible to avoid injections.

    const utils = require('projectphil-utils');
    let text = "oh hello world`; DROP DATABASE main;";
    let cleansed = await utils.sanitize(text, false) // boolean for <script> replacement in HTML
    await con.query(cleansed, function(err, row) {
        if(err) throw err;
    });

saveFile

Download and save a file from a URL. (NodeJS File Downloader)

    const utils = require('projectphil-utils');
    utils.saveFile("https://projectphil.co.uk/assets/logo.png", "logo", "png", "./public/images", false); // boolean is to clone files or not

getDate

Get the date and convert to string with NodeJS.

    const utils = require('projectphil-utils');
    let date = await utils.getDate();
    console.log(date);

fetchTime

Fetch the current time from a certain time zone.

    const utils = require('projectphil-utils');
    let time = await utils.fetchTime("America/New_York", "MM-DD-YYYY");
    console.log(date);

getRandomArray

Get a random element from an array of strings.

    const utils = require('projectphil-utils');
    let array = ["a", "b", "c", "d", "e", "f"];
    let random = await utils.getRandomArray(array);
    console.log(`you got: ${random}!`);

checkIfHex

Check if the provided string is a valid color hex.

    const utils = require('projectphil-utils');
    let hex = "#FFFFFF";
    let check = await utils.checkIfHex(hex);
    if(!check.pass) hex = check.item; // Set to the proper hex value if it's not
    console.log(hex);

dirSize

View the directory size of a folder.

    const utils = require('projectphil-utils');
    let size = await utils.dirSize("./src/images");
    console.log(size);

getDiscountedValue

Get the discounted amount of a total value.

const utils = require('projectphil-utils');
let totalValue = 34.99; // Price
let discount = 30; // 30%
let newValue = await utils.getDiscountedValue(totalValue, discount);
console.log(newValue) // 10.497 (30% of 34.99)

randomColor

Get a random color logged to the console.

const utils = require('projectphil-utils');
utils.randomColor("Wow a random color!!!");

Credits

@Project Phil - Creating the package.