@valkyriestudios/utils 12.11.0 → 12.12.0

package/README.md

@@ -431,6 +431,19 @@ Returns the current unix timestamp in seconds
 - **nowUnixMs()**
 Returns the current unix timestamp in milliseconds
 
+- **setTimeUTC(val:Date, props:{hour?:number;minute?:number;second?:number;millisecond?:number})**
+Take the incoming date and return a date where the time portion is set to the values in the provided props
+
+Note: Does not touch the date object passed
+```typescript
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {hour: 5}); // new Date("2023-05-04T05:04:27.432Z")
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {hour: 5, minute: 30}); // new Date("2023-05-04T05:30:27.432Z")
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {hour: 5, minute: 30, second: 0}); // new Date("2023-05-04T05:30:00.432Z")
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {hour: 5, minute: 30, second: 0, millisecond: 0}); // new Date("2023-05-04T05:30:00.000Z")
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {minute: 30, second: 0, millisecond: 0}); // new Date("2023-05-04T12:30:00.000Z")
+setTimeUTC(new Date("2023-05-04T12:04:27.432Z"), {second: 9, millisecond: 0}); // new Date("2023-05-04T12:04:09.000Z")
+```
+
 - **startOfUTC(val:Date, key:string)**
 Take the incoming date and return a date set to the start of passed key. Possible key options(year,quarter,month,week,week_sun,week_mon,week_tue,week_wed,week_thu,week_fri,week_sat,day,hour,minute,second).
 

package/date/format.js

@@ -41,16 +41,16 @@ function toZone(date, zone) {
 function runIntl(loc, token, props, val) {
     const hash = `${loc}:${token}`;
     let formatter = intl_formatters.get(hash);
-    if (formatter)
-        return formatter.format(val);
-    try {
-        formatter = new Intl.DateTimeFormat(loc, props);
-        intl_formatters.set(hash, formatter);
-        return formatter.format(val);
-    }
-    catch (err) {
-        throw new Error(`format: Failed to run conversion for ${token} with locale ${loc}`);
+    if (!formatter) {
+        try {
+            formatter = new Intl.DateTimeFormat(loc, props);
+            intl_formatters.set(hash, formatter);
+        }
+        catch (err) {
+            throw new Error(`format: Failed to run conversion for ${token} with locale ${loc}`);
+        }
     }
+    return formatter.format(val);
 }
 const Tokens = [
     ['YYYY', d => d.getFullYear()],
@@ -83,11 +83,13 @@ function getSpecChain(spec) {
         return spec_chain;
     spec_chain = [];
     let cursor;
+    let spec_cursor = spec;
     for (let i = 0; i < Tokens.length; i++) {
         cursor = Tokens[i];
-        if (spec.indexOf(cursor[0]) < 0)
+        if (spec_cursor.indexOf(cursor[0]) < 0)
             continue;
         spec_chain.push(cursor);
+        spec_cursor = spec_cursor.replace(cursor[1], '');
     }
     if (spec_chain.length === 0)
         return false;

package/date/index.d.ts

@@ -5,7 +5,8 @@ import { format } from './format';
 import { isDate } from './is';
 import { nowUnix } from './nowUnix';
 import { nowUnixMs } from './nowUnixMs';
+import { setTimeUTC } from './setTimeUTC';
 import { startOfUTC } from './startOfUTC';
 import { toUnix } from './toUnix';
 import { toUTC } from './toUTC';
-export { addUTC, diff, endOfUTC, format, isDate, isDate as is, nowUnix, nowUnixMs, startOfUTC, toUnix, toUTC };
+export { addUTC, diff, endOfUTC, format, isDate, isDate as is, nowUnix, nowUnixMs, setTimeUTC, startOfUTC, toUnix, toUTC };

package/date/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toUTC = exports.toUnix = exports.startOfUTC = exports.nowUnixMs = exports.nowUnix = exports.is = exports.isDate = exports.format = exports.endOfUTC = exports.diff = exports.addUTC = void 0;
+exports.toUTC = exports.toUnix = exports.startOfUTC = exports.setTimeUTC = exports.nowUnixMs = exports.nowUnix = exports.is = exports.isDate = exports.format = exports.endOfUTC = exports.diff = exports.addUTC = void 0;
 const addUTC_1 = require("./addUTC");
 Object.defineProperty(exports, "addUTC", { enumerable: true, get: function () { return addUTC_1.addUTC; } });
 const diff_1 = require("./diff");
@@ -16,6 +16,8 @@ const nowUnix_1 = require("./nowUnix");
 Object.defineProperty(exports, "nowUnix", { enumerable: true, get: function () { return nowUnix_1.nowUnix; } });
 const nowUnixMs_1 = require("./nowUnixMs");
 Object.defineProperty(exports, "nowUnixMs", { enumerable: true, get: function () { return nowUnixMs_1.nowUnixMs; } });
+const setTimeUTC_1 = require("./setTimeUTC");
+Object.defineProperty(exports, "setTimeUTC", { enumerable: true, get: function () { return setTimeUTC_1.setTimeUTC; } });
 const startOfUTC_1 = require("./startOfUTC");
 Object.defineProperty(exports, "startOfUTC", { enumerable: true, get: function () { return startOfUTC_1.startOfUTC; } });
 const toUnix_1 = require("./toUnix");

package/date/setTimeUTC.d.ts

@@ -0,0 +1,15 @@
+export type TimeProps = {
+    hour?: number;
+    minute?: number;
+    second?: number;
+    millisecond?: number;
+};
+/**
+ * Sets the time on a provided date object and returns it
+ *
+ * @param {Date} val - Date to set the time for
+ * @param {Time} props - Time props to set the time to
+ * @returns {Date} New date with provided amount of key added
+ */
+declare function setTimeUTC(val: Date, props: TimeProps): Date;
+export { setTimeUTC, setTimeUTC as default };

package/date/setTimeUTC.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTimeUTC = setTimeUTC;
+exports.default = setTimeUTC;
+const is_1 = require("./is");
+const isIntegerBetween_1 = require("../number/isIntegerBetween");
+function setTimeUTC(val, props) {
+    if (!(0, is_1.isDate)(val))
+        throw new TypeError('setTimeUTC requires a date object');
+    return new Date(Date.UTC(val.getUTCFullYear(), val.getUTCMonth(), val.getUTCDate(), (0, isIntegerBetween_1.isIntegerBetween)(props?.hour, 0, 23) ? props.hour : val.getUTCHours(), (0, isIntegerBetween_1.isIntegerBetween)(props?.minute, 0, 59) ? props?.minute : val.getUTCMinutes(), (0, isIntegerBetween_1.isIntegerBetween)(props?.second, 0, 59) ? props?.second : val.getUTCSeconds(), (0, isIntegerBetween_1.isIntegerBetween)(props?.millisecond, 0, 999) ? props?.millisecond : val.getUTCMilliseconds()));
+}

package/index.d.ts

@@ -146,6 +146,20 @@ declare module "date/nowUnixMs" {
     function nowUnixMs(): number;
     export { nowUnixMs, nowUnixMs as default };
 }
+declare module "number/isIntegerBetween" {
+    function isIntegerBetween(val: unknown, min: number, max: number): val is number;
+    export { isIntegerBetween, isIntegerBetween as default };
+}
+declare module "date/setTimeUTC" {
+    export type TimeProps = {
+        hour?: number;
+        minute?: number;
+        second?: number;
+        millisecond?: number;
+    };
+    function setTimeUTC(val: Date, props: TimeProps): Date;
+    export { setTimeUTC, setTimeUTC as default };
+}
 declare module "date/startOfUTC" {
     function startOfUTC(val: Date, key?: 'year' | 'quarter' | 'month' | 'week' | 'week_sun' | 'week_mon' | 'week_tue' | 'week_wed' | 'week_thu' | 'week_fri' | 'week_sat' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond'): Date;
     export { startOfUTC, startOfUTC as default };
@@ -166,10 +180,11 @@ declare module "date/index" {
     import { isDate } from "date/is";
     import { nowUnix } from "date/nowUnix";
     import { nowUnixMs } from "date/nowUnixMs";
+    import { setTimeUTC } from "date/setTimeUTC";
     import { startOfUTC } from "date/startOfUTC";
     import { toUnix } from "date/toUnix";
     import { toUTC } from "date/toUTC";
-    export { addUTC, diff, endOfUTC, format, isDate, isDate as is, nowUnix, nowUnixMs, startOfUTC, toUnix, toUTC };
+    export { addUTC, diff, endOfUTC, format, isDate, isDate as is, nowUnix, nowUnixMs, setTimeUTC, startOfUTC, toUnix, toUTC };
 }
 declare module "formdata/is" {
     function isFormData(val: unknown): val is FormData;
@@ -319,10 +334,6 @@ declare module "number/isIntegerBelowOrEqual" {
     function isIntegerBelowOrEqual(val: unknown, ref: number): val is number;
     export { isIntegerBelowOrEqual, isIntegerBelowOrEqual as default };
 }
-declare module "number/isIntegerBetween" {
-    function isIntegerBetween(val: unknown, min: number, max: number): val is number;
-    export { isIntegerBetween, isIntegerBetween as default };
-}
 declare module "number/randomBetween" {
     function randomBetween(min?: number, max?: number): number;
     export { randomBetween, randomBetween as default };

package/package.json

@@ -1 +1 @@
-{ "name": "@valkyriestudios/utils", "version": "12.11.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }
+{ "name": "@valkyriestudios/utils", "version": "12.12.0", "description": "A collection of single-function utilities for common tasks", "author": { "name": "Peter Vermeulen", "url": "https://www.linkedin.com/in/petervermeulen1/" }, "keywords": [ "utility", "library", "javascript", "js", "node", "bun" ], "license": "MIT", "repository": { "type": "git", "url": "git+https://github.com/ValkyrieStudios/utils.git" }, "bugs": { "url": "https://github.com/ValkyrieStudios/utils/issues" }, "homepage": "https://github.com/ValkyrieStudios/utils#readme", "types": "index.d.ts" }