@qrvey/utils 1.6.0-1 → 1.6.0-2

package/dist/cjs/dates/adapters/dateToHms.d.ts

@@ -1,6 +1,8 @@
+import { IDFDateToHmsSettings } from "../interfaces/IDFDateToHmsSettings";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
  * @param date String, object or millisencond number of the date
+ * @param settings the settings of the dateToHms function
  * @returns string of [HH:mm:ss] date format
  */
-export declare function dateToHms(date: string | Date | number): string;
+export declare function dateToHms(date: string | Date | number, settings?: IDFDateToHmsSettings): string;

package/dist/cjs/dates/adapters/dateToHms.js

@@ -7,14 +7,59 @@ const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * * Transform a Date to [HH:mm:ss] date format.
  * @param date String, object or millisencond number of the date
+ * @param settings the settings of the dateToHms function
  * @returns string of [HH:mm:ss] date format
  */
-function dateToHms(date) {
+function dateToHms(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))
         return date;
     const dt = new Date(date.valueOf());
     if (!(0, isValidDateObject_1.isValidDateObject)(dt))
         return date;
-    return `${(0, padLeadingZeros_1.padLeadingZeros)(dt.getHours(), 2).slice(-2)}:${(0, padLeadingZeros_1.padLeadingZeros)(dt.getMinutes(), 2).slice(-2)}:${(0, padLeadingZeros_1.padLeadingZeros)(dt.getSeconds(), 2).slice(-2)}`;
+    const defaultSettings = getDefaultSettings(settings);
+    const hours = getHours(dt, defaultSettings);
+    const minutes = getMinutes(dt, defaultSettings);
+    const seconds = getSeconds(dt, defaultSettings);
+    return `${hours}:${minutes}:${seconds}`;
 }
 exports.dateToHms = dateToHms;
+/**
+ * Gets the settings for this function.
+ * @param settings the settings of the dateToHms function
+ * @returns a new object for the settings
+ */
+function getDefaultSettings(settings) {
+    var _a, _b, _c;
+    return {
+        omitHour: (_a = settings === null || settings === void 0 ? void 0 : settings.omitHour) !== null && _a !== void 0 ? _a : false,
+        omitMinute: (_b = settings === null || settings === void 0 ? void 0 : settings.omitMinute) !== null && _b !== void 0 ? _b : false,
+        omitSecond: (_c = settings === null || settings === void 0 ? void 0 : settings.omitSecond) !== null && _c !== void 0 ? _c : false,
+    };
+}
+/**
+ * Gets the Hours
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the hour string
+ */
+function getHours(date, settings) {
+    return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitHour ? "0" : date.getHours(), 2).slice(-2);
+}
+/**
+ * Gets the Minutes
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the minute string
+ */
+function getMinutes(date, settings) {
+    return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitMinute ? "0" : date.getMinutes(), 2).slice(-2);
+}
+/**
+ * Gets the Seconds
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the seconds string
+ */
+function getSeconds(date, settings) {
+    return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitSecond ? "0" : date.getSeconds(), 2).slice(-2);
+}

package/dist/cjs/dates/interfaces/IDFDateToHmsSettings.d.ts

@@ -0,0 +1,5 @@
+export interface IDFDateToHmsSettings {
+    omitHour?: boolean;
+    omitMinute?: boolean;
+    omitSecond?: boolean;
+}

package/dist/cjs/dates/interfaces/IDFDateToHmsSettings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/dates/interfaces/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./IDateFormat";
 export * from "./IDateGroupingProperty";
+export * from "./IDFDateToHmsSettings";

package/dist/cjs/dates/interfaces/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./IDateFormat"), exports);
 __exportStar(require("./IDateGroupingProperty"), exports);
+__exportStar(require("./IDFDateToHmsSettings"), exports);

package/dist/dates/adapters/dateToHms.d.ts

@@ -1,6 +1,8 @@
+import { IDFDateToHmsSettings } from "../interfaces/IDFDateToHmsSettings";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
  * @param date String, object or millisencond number of the date
+ * @param settings the settings of the dateToHms function
  * @returns string of [HH:mm:ss] date format
  */
-export declare function dateToHms(date: string | Date | number): string;
+export declare function dateToHms(date: string | Date | number, settings?: IDFDateToHmsSettings): string;

package/dist/dates/adapters/dateToHms.js

@@ -4,13 +4,58 @@ import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
  * @param date String, object or millisencond number of the date
+ * @param settings the settings of the dateToHms function
  * @returns string of [HH:mm:ss] date format
  */
-export function dateToHms(date) {
+export function dateToHms(date, settings) {
     if (!isValidPotentialDate(date))
         return date;
     const dt = new Date(date.valueOf());
     if (!isValidDateObject(dt))
         return date;
-    return `${padLeadingZeros(dt.getHours(), 2).slice(-2)}:${padLeadingZeros(dt.getMinutes(), 2).slice(-2)}:${padLeadingZeros(dt.getSeconds(), 2).slice(-2)}`;
+    const defaultSettings = getDefaultSettings(settings);
+    const hours = getHours(dt, defaultSettings);
+    const minutes = getMinutes(dt, defaultSettings);
+    const seconds = getSeconds(dt, defaultSettings);
+    return `${hours}:${minutes}:${seconds}`;
+}
+/**
+ * Gets the settings for this function.
+ * @param settings the settings of the dateToHms function
+ * @returns a new object for the settings
+ */
+function getDefaultSettings(settings) {
+    var _a, _b, _c;
+    return {
+        omitHour: (_a = settings === null || settings === void 0 ? void 0 : settings.omitHour) !== null && _a !== void 0 ? _a : false,
+        omitMinute: (_b = settings === null || settings === void 0 ? void 0 : settings.omitMinute) !== null && _b !== void 0 ? _b : false,
+        omitSecond: (_c = settings === null || settings === void 0 ? void 0 : settings.omitSecond) !== null && _c !== void 0 ? _c : false,
+    };
+}
+/**
+ * Gets the Hours
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the hour string
+ */
+function getHours(date, settings) {
+    return padLeadingZeros(settings.omitHour ? "0" : date.getHours(), 2).slice(-2);
+}
+/**
+ * Gets the Minutes
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the minute string
+ */
+function getMinutes(date, settings) {
+    return padLeadingZeros(settings.omitMinute ? "0" : date.getMinutes(), 2).slice(-2);
+}
+/**
+ * Gets the Seconds
+ * @param date the date object
+ * @param settings the settings of the dateToHms function
+ * @returns the seconds string
+ */
+function getSeconds(date, settings) {
+    return padLeadingZeros(settings.omitSecond ? "0" : date.getSeconds(), 2).slice(-2);
 }

package/dist/dates/interfaces/IDFDateToHmsSettings.d.ts

@@ -0,0 +1,5 @@
+export interface IDFDateToHmsSettings {
+    omitHour?: boolean;
+    omitMinute?: boolean;
+    omitSecond?: boolean;
+}

package/dist/dates/interfaces/IDFDateToHmsSettings.js

@@ -0,0 +1 @@
+export {};

package/dist/dates/interfaces/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./IDateFormat";
 export * from "./IDateGroupingProperty";
+export * from "./IDFDateToHmsSettings";

package/dist/dates/interfaces/index.js

@@ -1,2 +1,3 @@
 export * from "./IDateFormat";
 export * from "./IDateGroupingProperty";
+export * from "./IDFDateToHmsSettings";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.6.0-1",
+  "version": "1.6.0-2",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",