@blackbyte/sugar 1.0.0-beta.27 → 1.0.0-beta.29

package/dist/shared/datetime/diffBetweenDates/diffBetweenDates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diffBetweenDates.js","sourceRoot":"","sources":["../../../../src/shared/datetime/diffBetweenDates/diffBetweenDates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAmClD,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAoB,EACpB,KAAoB,EACpB,QAA6C;IAS7C,MAAM,aAAa,mBACjB,MAAM,EAAE,EAAE,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,uBAAuB;IACvB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAEhD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEhD,MAAM,IAAI,GAAG,UAAU;SACpB,IAAI,CAAC,UAAU,EAAE;QAChB,OAAO;QACP,QAAQ;QACR,MAAM;QACN,OAAO;QACP,SAAS;QACT,SAAS;KACV,CAAC;SACD,QAAQ,EAAE,CAAC;IAEd,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/shared/datetime/formatDuration/formatDuration.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @name                formatDuration
+ * @namespace           shared.datetime
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function let you pass a duration in ms and get back a formatted estimation like "2.4m", "30s", etc...
+ *
+ * @param         {Number}        duration          The duration in ms to format
+ * @return        {String}                          The formatted estimation duration
+ *
+ * @todo      tests
+ *
+ * @snippet         formatDuration($1)
+ *
+ * @example       js
+ * import { formatDuration } from '@blackbyte/sugar/datetime';
+ * formatDuration(2000); // => 2s
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function formatDuration(duration: number): string;

package/dist/shared/datetime/formatDuration/formatDuration.js

@@ -0,0 +1,45 @@
+/**
+ * @name                formatDuration
+ * @namespace           shared.datetime
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function let you pass a duration in ms and get back a formatted estimation like "2.4m", "30s", etc...
+ *
+ * @param         {Number}        duration          The duration in ms to format
+ * @return        {String}                          The formatted estimation duration
+ *
+ * @todo      tests
+ *
+ * @snippet         formatDuration($1)
+ *
+ * @example       js
+ * import { formatDuration } from '@blackbyte/sugar/datetime';
+ * formatDuration(2000); // => 2s
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function formatDuration(duration) {
+    if (duration === Infinity) {
+        return '...';
+    }
+    if (duration < 1000) {
+        return `${duration}ms`;
+    }
+    if (duration < 1000 * 60) {
+        const s = duration / 1000;
+        return `${s.toFixed(2)}s`;
+    }
+    if (duration < 1000 * 60 * 60) {
+        const m = Math.floor(duration / 1000 / 60);
+        const s = Math.round((duration - m * 1000 * 60) / 1000);
+        return `${m}m${s > 0 ? `${s}s` : ''}`;
+    }
+    const h = Math.floor(duration / 1000 / 60 / 60);
+    const m = Math.floor((duration - h * 1000 * 60 * 60) / 1000 / 60);
+    return `${h}h${m > 0 ? `${m}m` : ''}`;
+}
+//# sourceMappingURL=formatDuration.js.map

package/dist/shared/datetime/formatDuration/formatDuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatDuration.js","sourceRoot":"","sources":["../../../../src/shared/datetime/formatDuration/formatDuration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,QAAgB;IACrD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;QACpB,OAAO,GAAG,QAAQ,IAAI,CAAC;IACzB,CAAC;IACD,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC;QAC1B,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAC5B,CAAC;IACD,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;QAC3C,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QACxD,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAChD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;IAClE,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACxC,CAAC"}

package/dist/shared/datetime/parseDate/parseDate.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @name                                parseDate
+ * @namespace                           shared.datetime
+ * @type                                Function
+ * @platform                            js
+ * @platform                            node
+ * @status                              stable
+ *
+ * This function allows you to parse a date string. It will returns the `Date` instance for this date.
+ * Under the hood, it make uses of the wonderful [Luxon](https://moment.github.io/luxon) library.
+ * Make sure to use the library if you need more control over your dates.
+ * Luxon support these date formats:
+ *
+ * - ISO 8601
+ * - RFC2822
+ * - HTTP (header)
+ *
+ * @param           {String}                    date                    The date string to parse
+ * @param           {TParseDateSettings}        [settings={}]           Some settings to configure your parsing
+ * @return          {Date}                                              The `Date` instance representing your date string
+ *
+ * @setting         {String}        [format='']                         If you know the format of your date string, you can pass it here. This will make the parsing faster and more reliable. See [Luxon documentation](https://moment.github.io/luxon/#/parsing?id=table-of-tokens) for the list of supported tokens.
+ *
+ * @snippet         parseDate($1, $2)
+ *
+ * @example           js
+ * import { parseDate } from '@blackbyte/sugar/datetime';
+ * parseDate('2025-10-12');
+ * parseDate('2024-10-15T10:30:00Z');
+ *
+ * @see             https://moment.github.io/luxon
+ * @since           1.0.0
+ * @author          Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TParseDateSettings = {
+    format: string;
+};
+export default function parseDate(date: string | Date, settings?: Partial<TParseDateSettings>): Date | null;

package/dist/shared/datetime/parseDate/parseDate.js

@@ -0,0 +1,34 @@
+import { DateTime } from 'luxon';
+export default function parseDate(date, settings) {
+    const finalSettings = Object.assign({ format: '' }, (settings !== null && settings !== void 0 ? settings : {}));
+    let luxonDate;
+    // if it is already a date, we just return it
+    if (date instanceof Date) {
+        return date;
+    }
+    // if a format is passed, we check this.
+    // if it's invalid, we return null
+    if (finalSettings.format) {
+        luxonDate = DateTime.fromFormat(date, finalSettings.format);
+    }
+    if (luxonDate === null || luxonDate === void 0 ? void 0 : luxonDate.invalid) {
+        return null;
+    }
+    // otherwise we try to parse the date string
+    // using all the format supported by luxon
+    luxonDate = DateTime.fromISO(date);
+    if (!(luxonDate === null || luxonDate === void 0 ? void 0 : luxonDate.invalid)) {
+        return luxonDate.toJSDate();
+    }
+    luxonDate = DateTime.fromRFC2822(date);
+    if (!(luxonDate === null || luxonDate === void 0 ? void 0 : luxonDate.invalid)) {
+        return luxonDate.toJSDate();
+    }
+    luxonDate = DateTime.fromHTTP(date);
+    if (!(luxonDate === null || luxonDate === void 0 ? void 0 : luxonDate.invalid)) {
+        return luxonDate.toJSDate();
+    }
+    // nothing worked...
+    return null;
+}
+//# sourceMappingURL=parseDate.js.map

package/dist/shared/datetime/parseDate/parseDate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseDate.js","sourceRoot":"","sources":["../../../../src/shared/datetime/parseDate/parseDate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAyCjC,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,IAAmB,EACnB,QAAsC;IAEtC,MAAM,aAAa,mBACjB,MAAM,EAAE,EAAE,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IACF,IAAI,SAAS,CAAC;IAEd,6CAA6C;IAC7C,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wCAAwC;IACxC,kCAAkC;IAClC,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACzB,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4CAA4C;IAC5C,0CAA0C;IAC1C,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAA,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,CAAC,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAA,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,CAAA,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,oBAAoB;IACpB,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/shared/datetime/sleep/sleep.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name            sleep
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @async
+ * @status          stable
+ *
+ * This function is a simple "setTimeout" wrapper inside a promise.
+ *
+ * @param         {Number}        timeout       The timeout to sleep in ms
+ * @return        {Promise}                     A simple promise resolved once the timeout is finished
+ *
+ * @todo      tests
+ *
+ * @snippet         sleep($1)
+ * await sleep($1)
+ *
+ * @example       js
+ * import { sleep } from '@blackbyte/sugar/datetime';
+ * await sleep(2000);
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sleep(timeout?: number): Promise<void>;

package/dist/shared/datetime/sleep/sleep.js

@@ -0,0 +1,34 @@
+/**
+ * @name            sleep
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @async
+ * @status          stable
+ *
+ * This function is a simple "setTimeout" wrapper inside a promise.
+ *
+ * @param         {Number}        timeout       The timeout to sleep in ms
+ * @return        {Promise}                     A simple promise resolved once the timeout is finished
+ *
+ * @todo      tests
+ *
+ * @snippet         sleep($1)
+ * await sleep($1)
+ *
+ * @example       js
+ * import { sleep } from '@blackbyte/sugar/datetime';
+ * await sleep(2000);
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function sleep(timeout = 0) {
+    return new Promise((resolve) => {
+        setTimeout(() => {
+            resolve();
+        }, timeout);
+    });
+}
+//# sourceMappingURL=sleep.js.map

package/dist/shared/datetime/sleep/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../../../src/shared/datetime/sleep/sleep.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,UAAkB,CAAC;IAC/C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/shared/datetime/timeAgo/timeAgo.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name                timeAgo
+ * @namespace           shared.datetime
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Simple "time" ago for your Unix timestamps and JavaScript Date objects.
+ *
+ * @param           {Number}             timestamp                 The timestamp to transform
+ * @param           {'short'|'medium'|'long'}       [format='medium']       The format you want back
+ * @return          {String}                                          The converted value
+ *
+ * @todo      tests
+ *
+ * @snippet         timeAgo($1)
+ *
+ * @example           js
+ * import { timeAgo } from '@blackbyte/sugar/datetime';
+ * timeAgo(1611344957); // => 7 secs ago
+ *
+ * @see         https://www.npmjs.com/package/js-ago
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function timeAgo(timestamp: number | Date, format?: 'short' | 'medium' | 'long'): string;

package/dist/shared/datetime/timeAgo/timeAgo.js

@@ -0,0 +1,38 @@
+// @ts-nocheck
+import __jsAgo from 'js-ago';
+/**
+ * @name                timeAgo
+ * @namespace           shared.datetime
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Simple "time" ago for your Unix timestamps and JavaScript Date objects.
+ *
+ * @param           {Number}             timestamp                 The timestamp to transform
+ * @param           {'short'|'medium'|'long'}       [format='medium']       The format you want back
+ * @return          {String}                                          The converted value
+ *
+ * @todo      tests
+ *
+ * @snippet         timeAgo($1)
+ *
+ * @example           js
+ * import { timeAgo } from '@blackbyte/sugar/datetime';
+ * timeAgo(1611344957); // => 7 secs ago
+ *
+ * @see         https://www.npmjs.com/package/js-ago
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function timeAgo(timestamp, format = 'medium') {
+    let finalTimestamp = timestamp;
+    if (timestamp instanceof Date) {
+        finalTimestamp = timestamp.getTime();
+    }
+    return __jsAgo(finalTimestamp, {
+        format,
+    });
+}
+//# sourceMappingURL=timeAgo.js.map

package/dist/shared/datetime/timeAgo/timeAgo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeAgo.js","sourceRoot":"","sources":["../../../../src/shared/datetime/timeAgo/timeAgo.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,OAAO,OAAO,MAAM,QAAQ,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAC7B,SAAwB,EACxB,SAAsC,QAAQ;IAE9C,IAAI,cAAc,GAAW,SAAS,CAAC;IACvC,IAAI,SAAS,YAAY,IAAI,EAAE,CAAC;QAC9B,cAAc,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAED,OAAO,OAAO,CAAC,cAAc,EAAE;QAC7B,MAAM;KACP,CAAC,CAAC;AACL,CAAC"}

package/dist/shared/datetime/toYyyyMmDd/toYyyyMmDd.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name                                toYyyyMmDd
+ * @namespace                           shared.datetime
+ * @type                                Function
+ * @platform                            js
+ * @platform                            node
+ * @status                              stable
+ *
+ * This function allows you to pass any date string or Date instance and get back this
+ * one formatted as `YYYY-MM-DD`.
+ * This format is useful when you need to store dates in a database, set a date input value, etc...
+ * Under the hood, it make uses of the wonderful [Luxon](https://moment.github.io/luxon) library.
+ *
+ * @param           {String}                            date                    The date (string) to convert to `YYYY-MM-DD`
+ * @param           {TtoYyyyMmDdSettings}               [settings={}]           Some settings to configure your parsing
+ * @return          {String}                                                    The date formatted as `YYYY-MM-DD`
+ *
+ * @setting         {String}        [format='']                                 If you know the format of your date string, you can pass it here. This will make the parsing faster and more reliable. See [Luxon documentation](https://moment.github.io/luxon/#/parsing?id=table-of-tokens) for the list of supported tokens.
+ *
+ * @snippet         toYyyyMmDd($1, $2, $3)
+ *
+ * @example           js
+ * import { toYyyyMmDd } from '@blackbyte/sugar/datetime';
+ * toYyyyMmDd('2025-10-15T14:30:00+02:00'); // '2025-10-15'
+ *
+ * @see             https://moment.github.io/luxon
+ * @since           1.0.0
+ * @author          Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TtoYyyyMmDdSettings = {
+    format: string;
+    separator: string;
+};
+export default function toYyyyMmDd(date: string | Date, settings?: Partial<TtoYyyyMmDdSettings>): string | null;

package/dist/shared/datetime/toYyyyMmDd/toYyyyMmDd.js

@@ -0,0 +1,19 @@
+import parseDate from '../parseDate/parseDate.js';
+export default function toYyyyMmDd(date, settings) {
+    const finalSettings = Object.assign({ format: '', separator: '-' }, (settings !== null && settings !== void 0 ? settings : {}));
+    if (typeof date === 'string' && date.match(/^\d{4}-\d{2}-\d{2}$/)) {
+        // already in the correct format
+        return date;
+    }
+    // prse the passed date
+    const jsDate = parseDate(date, finalSettings);
+    if (!jsDate) {
+        return null;
+    }
+    const dateStr = jsDate
+        .toISOString()
+        .split('T')[0]
+        .replace('-', finalSettings.separator);
+    return dateStr;
+}
+//# sourceMappingURL=toYyyyMmDd.js.map

package/dist/shared/datetime/toYyyyMmDd/toYyyyMmDd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toYyyyMmDd.js","sourceRoot":"","sources":["../../../../src/shared/datetime/toYyyyMmDd/toYyyyMmDd.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAqClD,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,IAAmB,EACnB,QAAuC;IAEvC,MAAM,aAAa,mBACjB,MAAM,EAAE,EAAE,EACV,SAAS,EAAE,GAAG,IACX,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAClE,gCAAgC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uBAAuB;IACvB,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,MAAM;SACnB,WAAW,EAAE;SACb,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACb,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACzC,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/shared/datetime/utcTime/utcTime.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @name            utcTime
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This method allows you to display easily the time in UTC format like "10:20:32"
+ *
+ * @param       {Boolean}          [hours=true]             Display the hours or not
+ * @param       {Boolean}          [minutes=true]             Display the minutes or not
+ * @param       {Boolean}          [seconds=true]             Display the seconds or not
+ * @param       {Date}           [date=new Date()]         The date to use to display the time
+ * @return      {String}                                    The time string
+ *
+ * @todo        tests
+ *
+ * @snippet         utcTime()
+ *
+ * @example         js
+ * import { utcTime } from '@blackbyte/sugar/date';
+ * utcTime(); // => 10:20:32
+ * utcTime(true, true, false); // => 10:20
+ *
+ * @since       1.0.0
+ * @author 	                Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function utcTime(hours?: boolean, minutes?: boolean, seconds?: boolean, date?: Date): string;

package/dist/shared/datetime/utcTime/utcTime.js

@@ -0,0 +1,39 @@
+/**
+ * @name            utcTime
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @status          stable
+ *
+ * This method allows you to display easily the time in UTC format like "10:20:32"
+ *
+ * @param       {Boolean}          [hours=true]             Display the hours or not
+ * @param       {Boolean}          [minutes=true]             Display the minutes or not
+ * @param       {Boolean}          [seconds=true]             Display the seconds or not
+ * @param       {Date}           [date=new Date()]         The date to use to display the time
+ * @return      {String}                                    The time string
+ *
+ * @todo        tests
+ *
+ * @snippet         utcTime()
+ *
+ * @example         js
+ * import { utcTime } from '@blackbyte/sugar/date';
+ * utcTime(); // => 10:20:32
+ * utcTime(true, true, false); // => 10:20
+ *
+ * @since       1.0.0
+ * @author 	                Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function utcTime(hours = true, minutes = true, seconds = true, date = new Date()) {
+    const timeAr = [];
+    if (hours)
+        timeAr.push(date.getHours());
+    if (minutes)
+        timeAr.push(date.getMinutes());
+    if (seconds)
+        timeAr.push(date.getSeconds());
+    return timeAr.join(':');
+}
+//# sourceMappingURL=utcTime.js.map

package/dist/shared/datetime/utcTime/utcTime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utcTime.js","sourceRoot":"","sources":["../../../../src/shared/datetime/utcTime/utcTime.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAC7B,KAAK,GAAG,IAAI,EACZ,OAAO,GAAG,IAAI,EACd,OAAO,GAAG,IAAI,EACd,IAAI,GAAG,IAAI,IAAI,EAAE;IAEjB,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,KAAK;QAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxC,IAAI,OAAO;QAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5C,IAAI,OAAO;QAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC"}

package/dist/shared/datetime/wait/wait.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name            wait
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @async
+ * @status          stable
+ *
+ * This function is a simple "setTimeout" wrapper inside a promise.
+ *
+ * @param         {Number}        timeout       The timeout to wait in ms
+ * @return        {Promise}                     A simple promise resolved once the timeout is finished
+ *
+ * @todo      tests
+ *
+ * @snippet         wait($1)
+ * await wait($1)
+ *
+ * @example       js
+ * import { wait } from '@blackbyte/sugar/datetime';
+ * await wait(2000);
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function wait(timeout?: number): Promise<void>;

package/dist/shared/datetime/wait/wait.js

@@ -0,0 +1,34 @@
+/**
+ * @name            wait
+ * @namespace       shared.datetime
+ * @type            Function
+ * @platform        js
+ * @platform        node
+ * @async
+ * @status          stable
+ *
+ * This function is a simple "setTimeout" wrapper inside a promise.
+ *
+ * @param         {Number}        timeout       The timeout to wait in ms
+ * @return        {Promise}                     A simple promise resolved once the timeout is finished
+ *
+ * @todo      tests
+ *
+ * @snippet         wait($1)
+ * await wait($1)
+ *
+ * @example       js
+ * import { wait } from '@blackbyte/sugar/datetime';
+ * await wait(2000);
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function wait(timeout = 0) {
+    return new Promise((resolve) => {
+        setTimeout(() => {
+            resolve();
+        }, timeout);
+    });
+}
+//# sourceMappingURL=wait.js.map

package/dist/shared/datetime/wait/wait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait.js","sourceRoot":"","sources":["../../../../src/shared/datetime/wait/wait.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,UAAkB,CAAC;IAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/shared/easing/_exports.d.ts

@@ -1,15 +1,15 @@
-import availableEasingsArray from './availableEasingsArray.js';
-import easeInCubic from './easeInCubic.js';
-import easeInOutCubic from './easeInOutCubic.js';
-import easeInOutQuad from './easeInOutQuad.js';
-import easeInOutQuart from './easeInOutQuart.js';
-import easeInOutQuint from './easeInOutQuint.js';
-import easeInQuad from './easeInQuad.js';
-import easeInQuart from './easeInQuart.js';
-import easeInQuint from './easeInQuint.js';
-import easeOutCubic from './easeOutCubic.js';
-import easeOutQuad from './easeOutQuad.js';
-import easeOutQuart from './easeOutQuart.js';
-import easeOutQuint from './easeOutQuint.js';
-import linear from './linear.js';
+import availableEasingsArray from './availableEasingsArray/availableEasingsArray.js';
+import easeInCubic from './easeInCubic/easeInCubic.js';
+import easeInOutCubic from './easeInOutCubic/easeInOutCubic.js';
+import easeInOutQuad from './easeInOutQuad/easeInOutQuad.js';
+import easeInOutQuart from './easeInOutQuart/easeInOutQuart.js';
+import easeInOutQuint from './easeInOutQuint/easeInOutQuint.js';
+import easeInQuad from './easeInQuad/easeInQuad.js';
+import easeInQuart from './easeInQuart/easeInQuart.js';
+import easeInQuint from './easeInQuint/easeInQuint.js';
+import easeOutCubic from './easeOutCubic/easeOutCubic.js';
+import easeOutQuad from './easeOutQuad/easeOutQuad.js';
+import easeOutQuart from './easeOutQuart/easeOutQuart.js';
+import easeOutQuint from './easeOutQuint/easeOutQuint.js';
+import linear from './linear/linear.js';
 export { availableEasingsArray as __availableEasingsArray, easeInCubic as __easeInCubic, easeInOutCubic as __easeInOutCubic, easeInOutQuad as __easeInOutQuad, easeInOutQuart as __easeInOutQuart, easeInOutQuint as __easeInOutQuint, easeInQuad as __easeInQuad, easeInQuart as __easeInQuart, easeInQuint as __easeInQuint, easeOutCubic as __easeOutCubic, easeOutQuad as __easeOutQuad, easeOutQuart as __easeOutQuart, easeOutQuint as __easeOutQuint, linear as __linear, availableEasingsArray, easeInCubic, easeInOutCubic, easeInOutQuad, easeInOutQuart, easeInOutQuint, easeInQuad, easeInQuart, easeInQuint, easeOutCubic, easeOutQuad, easeOutQuart, easeOutQuint, linear, };

package/dist/shared/easing/_exports.js

@@ -1,16 +1,16 @@
-import availableEasingsArray from './availableEasingsArray.js';
-import easeInCubic from './easeInCubic.js';
-import easeInOutCubic from './easeInOutCubic.js';
-import easeInOutQuad from './easeInOutQuad.js';
-import easeInOutQuart from './easeInOutQuart.js';
-import easeInOutQuint from './easeInOutQuint.js';
-import easeInQuad from './easeInQuad.js';
-import easeInQuart from './easeInQuart.js';
-import easeInQuint from './easeInQuint.js';
-import easeOutCubic from './easeOutCubic.js';
-import easeOutQuad from './easeOutQuad.js';
-import easeOutQuart from './easeOutQuart.js';
-import easeOutQuint from './easeOutQuint.js';
-import linear from './linear.js';
+import availableEasingsArray from './availableEasingsArray/availableEasingsArray.js';
+import easeInCubic from './easeInCubic/easeInCubic.js';
+import easeInOutCubic from './easeInOutCubic/easeInOutCubic.js';
+import easeInOutQuad from './easeInOutQuad/easeInOutQuad.js';
+import easeInOutQuart from './easeInOutQuart/easeInOutQuart.js';
+import easeInOutQuint from './easeInOutQuint/easeInOutQuint.js';
+import easeInQuad from './easeInQuad/easeInQuad.js';
+import easeInQuart from './easeInQuart/easeInQuart.js';
+import easeInQuint from './easeInQuint/easeInQuint.js';
+import easeOutCubic from './easeOutCubic/easeOutCubic.js';
+import easeOutQuad from './easeOutQuad/easeOutQuad.js';
+import easeOutQuart from './easeOutQuart/easeOutQuart.js';
+import easeOutQuint from './easeOutQuint/easeOutQuint.js';
+import linear from './linear/linear.js';
 export { availableEasingsArray as __availableEasingsArray, easeInCubic as __easeInCubic, easeInOutCubic as __easeInOutCubic, easeInOutQuad as __easeInOutQuad, easeInOutQuart as __easeInOutQuart, easeInOutQuint as __easeInOutQuint, easeInQuad as __easeInQuad, easeInQuart as __easeInQuart, easeInQuint as __easeInQuint, easeOutCubic as __easeOutCubic, easeOutQuad as __easeOutQuad, easeOutQuart as __easeOutQuart, easeOutQuint as __easeOutQuint, linear as __linear, availableEasingsArray, easeInCubic, easeInOutCubic, easeInOutQuad, easeInOutQuart, easeInOutQuint, easeInQuad, easeInQuart, easeInQuint, easeOutCubic, easeOutQuad, easeOutQuart, easeOutQuint, linear, };
 //# sourceMappingURL=_exports.js.map

package/dist/shared/easing/_exports.js.map

@@ -1 +1 @@
-{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/easing/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,EACL,qBAAqB,IAAI,uBAAuB,EAChD,WAAW,IAAI,aAAa,EAC5B,cAAc,IAAI,gBAAgB,EAClC,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,cAAc,IAAI,gBAAgB,EAClC,UAAU,IAAI,YAAY,EAC1B,WAAW,IAAI,aAAa,EAC5B,WAAW,IAAI,aAAa,EAC5B,YAAY,IAAI,cAAc,EAC9B,WAAW,IAAI,aAAa,EAC5B,YAAY,IAAI,cAAc,EAC9B,YAAY,IAAI,cAAc,EAC9B,MAAM,IAAI,QAAQ,EAClB,qBAAqB,EACrB,WAAW,EACX,cAAc,EACd,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,WAAW,EACX,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,MAAM,GACP,CAAC"}
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/easing/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,kDAAkD,CAAC;AACrF,OAAO,WAAW,MAAM,8BAA8B,CAAC;AACvD,OAAO,cAAc,MAAM,oCAAoC,CAAC;AAChE,OAAO,aAAa,MAAM,kCAAkC,CAAC;AAC7D,OAAO,cAAc,MAAM,oCAAoC,CAAC;AAChE,OAAO,cAAc,MAAM,oCAAoC,CAAC;AAChE,OAAO,UAAU,MAAM,4BAA4B,CAAC;AACpD,OAAO,WAAW,MAAM,8BAA8B,CAAC;AACvD,OAAO,WAAW,MAAM,8BAA8B,CAAC;AACvD,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAC1D,OAAO,WAAW,MAAM,8BAA8B,CAAC;AACvD,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAC1D,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAC1D,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAExC,OAAO,EACL,qBAAqB,IAAI,uBAAuB,EAChD,WAAW,IAAI,aAAa,EAC5B,cAAc,IAAI,gBAAgB,EAClC,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,cAAc,IAAI,gBAAgB,EAClC,UAAU,IAAI,YAAY,EAC1B,WAAW,IAAI,aAAa,EAC5B,WAAW,IAAI,aAAa,EAC5B,YAAY,IAAI,cAAc,EAC9B,WAAW,IAAI,aAAa,EAC5B,YAAY,IAAI,cAAc,EAC9B,YAAY,IAAI,cAAc,EAC9B,MAAM,IAAI,QAAQ,EAClB,qBAAqB,EACrB,WAAW,EACX,cAAc,EACd,aAAa,EACb,cAAc,EACd,cAAc,EACd,UAAU,EACV,WAAW,EACX,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,MAAM,GACP,CAAC"}

package/dist/shared/easing/availableEasingsArray/availableEasingsArray.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @name                availableEasingsArray
+ * @namespace           shared.easing
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function simply return back an array of all the available easings function in the sugar toolkit
+ *
+ * @return      {Array}             An array of all the easing functions available
+ *
+ * @snippet         availableEasingsArray()
+ *
+ * @example         js
+ * import { availableEasingsArray } from '@blackbyte/sugar/easing';
+ * availableEasingsArray();
+ *
+ * @todo      tests
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function availableEasingsArray(): string[];

package/dist/shared/easing/availableEasingsArray/availableEasingsArray.js

@@ -0,0 +1,40 @@
+/**
+ * @name                availableEasingsArray
+ * @namespace           shared.easing
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function simply return back an array of all the available easings function in the sugar toolkit
+ *
+ * @return      {Array}             An array of all the easing functions available
+ *
+ * @snippet         availableEasingsArray()
+ *
+ * @example         js
+ * import { availableEasingsArray } from '@blackbyte/sugar/easing';
+ * availableEasingsArray();
+ *
+ * @todo      tests
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function availableEasingsArray() {
+    return [
+        'easeInOutCubic',
+        'easeInOutQuad',
+        'easeInOutQuart',
+        'easeInOutQuint',
+        'easeInCubic',
+        'easeInQuad',
+        'easeInQuart',
+        'easeInQuint',
+        'easeOutCubic',
+        'easeOutQuad',
+        'easeOutQuart',
+        'easeOutQuint',
+    ];
+}
+//# sourceMappingURL=availableEasingsArray.js.map

package/dist/shared/easing/availableEasingsArray/availableEasingsArray.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"availableEasingsArray.js","sourceRoot":"","sources":["../../../../src/shared/easing/availableEasingsArray/availableEasingsArray.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB;IAC3C,OAAO;QACL,gBAAgB;QAChB,eAAe;QACf,gBAAgB;QAChB,gBAAgB;QAChB,aAAa;QACb,YAAY;QACZ,aAAa;QACb,aAAa;QACb,cAAc;QACd,aAAa;QACb,cAAc;QACd,cAAc;KACf,CAAC;AACJ,CAAC"}