@evolis/evolis-library 1.1.0 → 1.2.1

package/converters.js

@@ -1,190 +0,0 @@
-/**
- * @module converters
- * @author EmpireDemocratiqueDuPoulpe
- * @version 1.0.6
- * @license MIT
- */
-import checkers from "./checkers.js";
-import functions from "./functions.js";
-
-/*****************************************************
- * Converters
- *****************************************************/
-
-/* ---- Array ----------------------------------- */
-/**
- * @function arrayToSerialComma
- *
- * @param {Array<*>} array - The array to convert
- * @returns {string} A string formatted as a serial comma
- *
- * @example
- * arrayToSerialComma([]) // return ""
- * arrayToSerialComma(["one", 2, "three"]) // return "one, 2, three"
- */
-function arrayToSerialComma(array) {
-	return checkers.isArray(array) && array.length > 0
-		? array.length === 1
-			? array[0]
-			: `${array.slice(0, -1).join(", ")} et ${array.slice(-1)}`
-		: "";
-}
-
-/* ---- Date ------------------------------------ */
-/**
- * @function dateToString
- *
- * @param {Date} date - The date to convert
- * @param {Boolean} [withTime=true] - Include time in the result
- * @param {string} [locale="fr-FR"] - The locale used in the conversion. It may changed the returned string format
- * @returns {string} A date formatted like "dd/MM/yyyy [hh:mm:ss]"
- *
- * @example
- * dateToString(new Date()) // return "13/07/2021, 14:59:48"
- */
-function dateToString(date, withTime = true, locale = "fr-FR") {
-	return withTime ? date.toLocaleString(locale) : date.toLocaleDateString(locale);
-}
-
-/**
- * @function dateToTimeString
- *
- * @param {Date} date - The date to convert
- * @param {string} [locale="fr-FR"] - The locale used in the conversion. It may changed the returned string format
- * @returns {string} A date formatted like "hh:mm:ss"
- *
- * @example
- * dateToTimeString(new Date()) // return "14:59:48"
- */
-function dateToTimeString(date, locale = "fr-FR") {
-	return date.toLocaleTimeString(locale);
-}
-
-/**
- * @function dateToFieldString
- *
- * @param {Date} date - The date to convert
- * @returns {string} A date formatted like "yyyy-MM-dd"
- *
- * @example
- * dateToFieldString(new Date()) // return "2021-07-13"
- */
-function dateToFieldString(date) {
-	return checkers.isDate(date)
-		? `${date.getFullYear()}-${functions.padLeft(date.getMonth() + 1)}-${functions.padLeft(date.getDate())}`
-		: null;
-}
-
-/**
- * @function timeStrToDate
- *
- * @param {string} time - The time to convert
- * @param {string} [format="hh:mm"] - The format used for conversion
- * @returns {Date} A date object filled with the time string provided
- * @throws {Error} In case of invalid format/time string
- *
- * @example
- * timeStrToDate("12:57") // works
- * timeStrToDate("9:21") // works
- * timeStrToDate("9::21") // error
- */
-function timeStrToDate(time, format = "hh:mm") {
-	if (!checkers.isString(time) || !checkers.isString(format)) return null;
-
-	const now = new Date();
-	const timeSplit = time.split(":");
-	const formatSplit = format.split(":");
-
-	formatSplit.forEach((f, index) => {
-		if (index >= timeSplit.length) throw Error("timeStrToDate - Invalid format");
-		const t = parseInt(timeSplit[index], 10);
-
-		if (f === "hh") now.setHours(t);
-		else if (f === "mm") now.setMinutes(t);
-		else if (f === "ss") now.setSeconds(t);
-	});
-
-	return now;
-}
-
-/**
- * @function secondsToReadable
- *
- * @param {number} seconds - Seconds to convert
- * @returns {string} The converted seconds and epoch
- *
- * @example
- * secondsToReadable(120) // return "2 minutes"
- * secondsToReadable(3600) // return "1 heure"
- */
-function secondsToReadable(seconds) {
-	const epochs = { "années": 31536000, "mois": 2592000, "jours": 86400, "heures": 3600, "minutes": 60, "secondes": 1 };
-	const singular = { "années": "ans", "mois": "mois", "jours": "jour", "heures": "heure", "minutes": "minute", "secondes": "seconde" };
-	const epoch = Object.entries(epochs).filter(([, value]) => seconds >= value).shift();
-	const readable = {
-		epoch: epoch[0],
-		interval: Math.trunc(seconds / epoch[1])
-	};
-
-	if (readable.interval === 1) {
-		readable.epoch = singular[readable.epoch];
-	}
-
-	return `${readable.interval} ${readable.epoch}`;
-}
-
-/**
- * @function toDate
- *
- * @param {*} d - The thing to convert
- * @returns {Date|null|undefined|NaN} A date object, null/undefined if the provided value is null/undefined and NaN if it's not convertible.
- *
- * @example
- * toDate(null) // return null
- * toDate(new Date().toISOString()) // return a Date object
- */
-function toDate(d) {
-	return (
-		d === null ? d :
-			d === undefined ? d :
-				d.constructor === Date ? d :
-					d.constructor === Array ? new Date(d[0],d[1],d[2]) :
-						d.constructor === Number ? new Date(d) :
-							d.constructor === String ? new Date(d) :
-								typeof d === "object" ? new Date(d.year,d.month,d.date) :
-									NaN
-	);
-}
-
-/* ---- Bytes ----------------------------------- */
-/**
- * @function bytesToReadable
- *
- * @param {number} bytes - Bytes to convert
- * @param {number} [decimals=2] - How many decimals
- * @returns {string} The converted bytes size to the closest unit
- *
- * @example
- * bytesToReadable(8000000) // return "7.63 MB"
- * bytesToReadable(8000000, 0) // return "8 MB"
- */
-function bytesToReadable(bytes, decimals = 2) {
-	if (bytes === 0) return "0 Bytes";
-
-	const k = 1024;
-	const dm = decimals < 0 ? 0 : decimals;
-	const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
-
-	const i = Math.floor(Math.log(bytes) / Math.log(k));
-	return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
-}
-
-/*****************************************************
- * Export
- *****************************************************/
-
-export default {
-	arrayToSerialComma,
-	dateToString, dateToTimeString, dateToFieldString, timeStrToDate, secondsToReadable, toDate,
-	bytesToReadable
-};

package/functions.js

@@ -1,78 +0,0 @@
-/**
- * @module functions
- * @author EmpireDemocratiqueDuPoulpe
- * @version 1.0.5
- * @license MIT
- */
-import checkers from "./checkers.js";
-
-/*****************************************************
- * Functions
- *****************************************************/
-
-/* ---- Array ----------------------------------- */
-/**
- * @function shuffle
- *
- * @param {Array<*>} array - The array to shuffle
- * @returns {Array<*>} The shuffled array
- *
- * @example
- * shuffle([1, 2, 3]) // return [2, 1, 3] or [3, 2, 1] or [1, 3, 2] or ...
- */
-function shuffle(array) {
-	let arr = [...array], length = array.length, element, cache;
-
-	while (length) {
-		element = Math.floor(Math.random() * length--);
-
-		cache = arr[length];
-		arr[length] = arr[element];
-		arr[element] = cache;
-	}
-
-	return arr;
-}
-
-/* ---- Date ------------------------------------ */
-/**
- * @function dayDifference
- *
- * @param {Date} start - Start date
- * @param {Date} end - End date
- * @returns {Number} How many days between these two dates
- *
- * @example
- * dayDifference(new Date("07/14/2021"), new Date("07/18/2021")) // return 4
- * dayDifference(new Date("07/14/2021"), new Date("07/01/2021")) // return -13
- */
-function dayDifference(start, end) {
-	start.setHours(0, 0, 0, 0);
-	end.setHours(0, 0, 0, 0);
-
-	return Math.round((end.getTime() - start.getTime()) / (1000 * 3600 * 24));
-}
-
-/* ---- Other ----------------------------------- */
-/**
- * @function padLeft
- *
- * @param {*} value - The value to pad
- * @param {string} [pad="00"] - With what to pad
- * @returns {string} The padded string
- *
- * @example
- * padLeft(5, "000") // return "005"
- * padLeft("796", "00") // return "796"
- */
-function padLeft(value, pad = "00") {
-	return checkers.isDefined(value)
-		? (value.toString.length >= pad.length) ? value : (pad + value).slice(-pad.length)
-		: pad;
-}
-
-/*****************************************************
- * Export
- *****************************************************/
-
-export default { shuffle, dayDifference, padLeft };