@libchrono/time 1.1.0 → 1.2.0

package/README.md

@@ -84,6 +84,13 @@ console.log(getMilitaryTimes('00:00', '23:59', 10)) // Output: ['00:00', '00:10'
 console.log(getMeridiemTimes('08:30 AM', '12:00 PM', 30)) // Output: ['08:30 AM', '09:00 AM', '09:30 AM', ..., '12:00 PM']
 ```
 
+### Calculate seconds in time window
+
+```ts
+calculateMilitaryTimeWindowInSec('08:00', '12:00'); // 14400
+calculateMeridiemTimeWindowInSec('8:00 AM', '12:00 PM'); // 14400
+```
+
 [Full documentation](./docs/globals.md)
 
 ## 🛠️ Why Use @libchrono/time

package/dist/calculations.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Calculates the time window length in seconds between two **military** time strings (`HH:mm`).
+ *
+ * @example
+ * ```ts
+ * calculateMilitaryTimeWindowInSec('08:00', '12:00'); // 14400
+ * ```
+ *
+ * @param startStr - Start time in `HH:mm` format.
+ * @param endStr - End time in `HH:mm` format.
+ * @returns The number of seconds between start and end.
+ * @throws {@link Error} If end time is before start time.
+ */
+export declare const calculateMilitaryTimeWindowInSec: (startStr: string, endStr: string) => number;
+/**
+ * Calculates the time window length in seconds between two **meridiem** time strings (e.g. `8:00 AM`).
+ *
+ * The inputs are converted to military format and parsed into components before calculating the delta.
+ *
+ * @example
+ * ```ts
+ * calculateMeridiemTimeWindowInSec('8:00 AM', '12:00 PM'); // 14400
+ * ```
+ *
+ * @param startStr - Start time in meridiem format (e.g. `8:00 AM`).
+ * @param endStr - End time in meridiem format (e.g. `12:00 PM`).
+ * @returns The number of seconds between start and end.
+ * @throws {@link Error} If end time is before start time.
+ */
+export declare const calculateMeridiemTimeWindowInSec: (startStr: string, endStr: string) => number;

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from "./type/enum/meridiem";
 export * from "./type/enum/time-component";
 export * from "./type/meridiem-time-components";
 export * from "./type/military-time-components";
+export * from "./calculations";
 export * from "./checkers";
 export * from "./converters";
 export * from "./extractors";

package/dist/index.js

@@ -1 +1 @@
-!function(e,i){"object"===typeof exports&&"object"===typeof module?module.exports=i():"function"===typeof define&&define.amd?define([],i):"object"===typeof exports?exports["libchrono-time"]=i():e["libchrono-time"]=i()}(this,()=>(()=>{"use strict";var e={51(e,i,r){Object.defineProperty(i,"__esModule",{value:!0});r(707)},63(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.getMeridiemTimes=i.getMilitaryTimes=void 0;const o=r(707),t=r(492),n=r(704),m=r(552),d=(e,i)=>{let r=e[o.TimeComponent.Minute];return i<e[o.TimeComponent.Hour]&&(r=60),0===r&&(r=1),r},M=(e,i)=>{let r=e[o.TimeComponent.Minute];return i!==e[o.TimeComponent.Hour]&&(r=0),r};i.getMilitaryTimes=(e,i,r=30)=>((e,i,r)=>{const t=[];for(let n=e[o.TimeComponent.Hour];n<=i[o.TimeComponent.Hour];n++){const o=(0,m.padTimeNumber)(n),a=M(e,n),l=d(i,n);for(let e=a;e<l;e+=r){const i=`${o}:${(0,m.padTimeNumber)(e)}`;t.push(i)}}return t})((0,t.getMilitaryComponents)(e),(0,t.getMilitaryComponents)(i),r);i.getMeridiemTimes=(e,r,o=30)=>{const t=(0,n.convertMeridiemToMilitary)(e),m=(0,n.convertMeridiemToMilitary)(r);return(0,i.getMilitaryTimes)(t,m,o).map(n.convertMilitaryToMeridiem)}},239(e,i){Object.defineProperty(i,"__esModule",{value:!0}),i.PMPeriodRegex=i.AMPeriodRegex=i.MeridiemTimeRegex=i.MilitaryTimeRegex=void 0,i.MilitaryTimeRegex=/^([01]?\d|2[0-3])\D?([0-5][0-9])$/,i.MeridiemTimeRegex=/^(0?[1-9]|1[0-2]):([0-5][0-9])\s?(am|pm|a\.m\.|p\.m\.|a\.m|p\.m|a m|p m)$/i,i.AMPeriodRegex=/\bam|\ba\.m\.|\ba\.m\b/i,i.PMPeriodRegex=/\bpm|\bp\.m\.|\bp\.m\b/i},492(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.getMeridiemComponents=i.getMilitaryComponents=void 0;const o=r(721),t=r(239),n=r(550),m=r(707),d=e=>(0,o.isPreNoonPeriodStr)(e)?n.Meridiem.AM:n.Meridiem.PM;i.getMilitaryComponents=e=>{const i=e.match(t.MilitaryTimeRegex);if(null===i)throw new Error(`Provided invalid time value: ${e}`);return{[m.TimeComponent.Hour]:parseInt(i[1],10),[m.TimeComponent.Minute]:parseInt(i[2],10)}};i.getMeridiemComponents=e=>{const i=e.match(t.MeridiemTimeRegex);if(null===i)throw new Error(`Provided invalid time value: ${e}`);return{[m.TimeComponent.Hour]:parseInt(i[1],10),[m.TimeComponent.Minute]:parseInt(i[2],10),[m.TimeComponent.Period]:d(i[3])}}},542(e,i,r){Object.defineProperty(i,"__esModule",{value:!0});r(707)},550(e,i){var r,o,t,n;Object.defineProperty(i,"__esModule",{value:!0}),i.CivilianTimePeriod=i.TimeOfDay=i.DayPeriod=i.Meridiem=void 0,function(e){e.AM="AM",e.PM="PM"}(r||(i.Meridiem=r={})),function(e){e.AM="AM",e.PM="PM"}(o||(i.DayPeriod=o={})),function(e){e.AM="AM",e.PM="PM"}(t||(i.TimeOfDay=t={})),function(e){e.AM="AM",e.PM="PM"}(n||(i.CivilianTimePeriod=n={}));o.AM},552(e,i){Object.defineProperty(i,"__esModule",{value:!0}),i.padTimeNumber=void 0;i.padTimeNumber=e=>{if(e<0)throw new Error("Time number cant be negative");if(e>59)throw new Error("Time number cant be higher then 59");return e<10?`0${e}`:`${e}`}},704(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.toMeridiem=i.convert24To12=i.convertMilitaryToCivil=i.convertMilitaryToMeridiem=i.toMilitary=i.convert12To24=i.convertCivilToMilitary=i.convertMeridiemToMilitary=void 0;const o=r(721),t=r(492),n=r(552),m=r(550);i.convertMeridiemToMilitary=e=>{if(!(0,o.isMeridiemFormat)(e))throw new Error(`Provided invalid format to convert: ${e}`);const i=(0,t.getMeridiemComponents)(e),r=(e=>e.hour%12+(e.period===m.Meridiem.PM?12:0))(i);return d=r,M=i.minute,`${(0,n.padTimeNumber)(d)}:${(0,n.padTimeNumber)(M)}`;var d,M},i.convertCivilToMilitary=i.convertMeridiemToMilitary,i.convert12To24=i.convertMeridiemToMilitary,i.toMilitary=i.convertMeridiemToMilitary;i.convertMilitaryToMeridiem=e=>{if(!(0,o.isMilitaryFormat)(e))throw new Error(`Provided invalid format to convert: ${e}`);const i=(0,t.getMilitaryComponents)(e),r=i.hour%12||12,d=i.hour>=12?m.Meridiem.PM:m.Meridiem.AM;return((e,i,r)=>`${(0,n.padTimeNumber)(e)}:${(0,n.padTimeNumber)(i)} ${r}`)(r,i.minute,d)},i.convertMilitaryToCivil=i.convertMilitaryToMeridiem,i.convert24To12=i.convertMilitaryToMeridiem,i.toMeridiem=i.convertMilitaryToMeridiem},707(e,i){var r;Object.defineProperty(i,"__esModule",{value:!0}),i.TimeComponent=void 0,function(e){e.Hour="hour",e.Minute="minute",e.Period="period"}(r||(i.TimeComponent=r={}))},721(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.isPMPeriodStr=i.isPostNoonPeriodStr=i.isAMPeriodStr=i.isPreNoonPeriodStr=i.isMeridiemFormat=i.isMilitaryFormat=void 0;const o=r(239);i.isMilitaryFormat=e=>o.MilitaryTimeRegex.test(e);i.isMeridiemFormat=e=>o.MeridiemTimeRegex.test(e);i.isPreNoonPeriodStr=e=>o.AMPeriodRegex.test(e),i.isAMPeriodStr=i.isPreNoonPeriodStr;i.isPostNoonPeriodStr=e=>o.PMPeriodRegex.test(e),i.isPMPeriodStr=i.isPostNoonPeriodStr},729(e,i,r){var o=this&&this.__createBinding||(Object.create?function(e,i,r,o){void 0===o&&(o=r);var t=Object.getOwnPropertyDescriptor(i,r);t&&!("get"in t?!i.__esModule:t.writable||t.configurable)||(t={enumerable:!0,get:function(){return i[r]}}),Object.defineProperty(e,o,t)}:function(e,i,r,o){void 0===o&&(o=r),e[o]=i[r]}),t=this&&this.__exportStar||function(e,i){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(i,r)||o(i,e,r)};Object.defineProperty(i,"__esModule",{value:!0}),t(r(550),i),t(r(707),i),t(r(51),i),t(r(542),i),t(r(721),i),t(r(704),i),t(r(492),i),t(r(63),i)}},i={};var r=function r(o){var t=i[o];if(void 0!==t)return t.exports;var n=i[o]={exports:{}};return e[o].call(n.exports,n,n.exports,r),n.exports}(729);return r})());
+!function(e,i){"object"===typeof exports&&"object"===typeof module?module.exports=i():"function"===typeof define&&define.amd?define([],i):"object"===typeof exports?exports["libchrono-time"]=i():e["libchrono-time"]=i()}(this,()=>(()=>{"use strict";var e={51(e,i,r){Object.defineProperty(i,"__esModule",{value:!0});r(707)},63(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.getMeridiemTimes=i.getMilitaryTimes=void 0;const t=r(707),o=r(492),n=r(704),m=r(552),d=(e,i)=>{let r=e[t.TimeComponent.Minute];return i<e[t.TimeComponent.Hour]&&(r=60),0===r&&(r=1),r},M=(e,i)=>{let r=e[t.TimeComponent.Minute];return i!==e[t.TimeComponent.Hour]&&(r=0),r};i.getMilitaryTimes=(e,i,r=30)=>((e,i,r)=>{const o=[];for(let n=e[t.TimeComponent.Hour];n<=i[t.TimeComponent.Hour];n++){const t=(0,m.padTimeNumber)(n),a=M(e,n),l=d(i,n);for(let e=a;e<l;e+=r){const i=`${t}:${(0,m.padTimeNumber)(e)}`;o.push(i)}}return o})((0,o.getMilitaryComponents)(e),(0,o.getMilitaryComponents)(i),r);i.getMeridiemTimes=(e,r,t=30)=>{const o=(0,n.convertMeridiemToMilitary)(e),m=(0,n.convertMeridiemToMilitary)(r);return(0,i.getMilitaryTimes)(o,m,t).map(n.convertMilitaryToMeridiem)}},239(e,i){Object.defineProperty(i,"__esModule",{value:!0}),i.PMPeriodRegex=i.AMPeriodRegex=i.MeridiemTimeRegex=i.MilitaryTimeRegex=void 0,i.MilitaryTimeRegex=/^([01]?\d|2[0-3])\D?([0-5][0-9])$/,i.MeridiemTimeRegex=/^(0?[1-9]|1[0-2]):([0-5][0-9])\s?(am|pm|a\.m\.|p\.m\.|a\.m|p\.m|a m|p m)$/i,i.AMPeriodRegex=/\bam|\ba\.m\.|\ba\.m\b/i,i.PMPeriodRegex=/\bpm|\bp\.m\.|\bp\.m\b/i},331(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.calculateMeridiemTimeWindowInSec=i.calculateMilitaryTimeWindowInSec=void 0;const t=r(492),o=r(707),n=r(704),m=e=>3600*e[o.TimeComponent.Hour]+60*e[o.TimeComponent.Minute],d=(e,i)=>{const r=m(e),t=m(i);if(r>t)throw new Error("End time cant be before start time.");return t-r};i.calculateMilitaryTimeWindowInSec=(e,i)=>{const r=(0,t.getMilitaryComponents)(e),o=(0,t.getMilitaryComponents)(i);return d(r,o)};i.calculateMeridiemTimeWindowInSec=(e,i)=>{const r=(0,t.getMilitaryComponents)((0,n.convertMeridiemToMilitary)(e)),o=(0,t.getMilitaryComponents)((0,n.convertMeridiemToMilitary)(i));return d(r,o)}},492(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.getMeridiemComponents=i.getMilitaryComponents=void 0;const t=r(721),o=r(239),n=r(550),m=r(707),d=e=>(0,t.isPreNoonPeriodStr)(e)?n.Meridiem.AM:n.Meridiem.PM;i.getMilitaryComponents=e=>{const i=e.match(o.MilitaryTimeRegex);if(null===i)throw new Error(`Provided invalid time value: ${e}`);return{[m.TimeComponent.Hour]:parseInt(i[1],10),[m.TimeComponent.Minute]:parseInt(i[2],10)}};i.getMeridiemComponents=e=>{const i=e.match(o.MeridiemTimeRegex);if(null===i)throw new Error(`Provided invalid time value: ${e}`);return{[m.TimeComponent.Hour]:parseInt(i[1],10),[m.TimeComponent.Minute]:parseInt(i[2],10),[m.TimeComponent.Period]:d(i[3])}}},542(e,i,r){Object.defineProperty(i,"__esModule",{value:!0});r(707)},550(e,i){var r,t,o,n;Object.defineProperty(i,"__esModule",{value:!0}),i.CivilianTimePeriod=i.TimeOfDay=i.DayPeriod=i.Meridiem=void 0,function(e){e.AM="AM",e.PM="PM"}(r||(i.Meridiem=r={})),function(e){e.AM="AM",e.PM="PM"}(t||(i.DayPeriod=t={})),function(e){e.AM="AM",e.PM="PM"}(o||(i.TimeOfDay=o={})),function(e){e.AM="AM",e.PM="PM"}(n||(i.CivilianTimePeriod=n={}));t.AM},552(e,i){Object.defineProperty(i,"__esModule",{value:!0}),i.padTimeNumber=void 0;i.padTimeNumber=e=>{if(e<0)throw new Error("Time number cant be negative");if(e>59)throw new Error("Time number cant be higher then 59");return e<10?`0${e}`:`${e}`}},704(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.toMeridiem=i.convert24To12=i.convertMilitaryToCivil=i.convertMilitaryToMeridiem=i.toMilitary=i.convert12To24=i.convertCivilToMilitary=i.convertMeridiemToMilitary=void 0;const t=r(721),o=r(492),n=r(552),m=r(550);i.convertMeridiemToMilitary=e=>{if(!(0,t.isMeridiemFormat)(e))throw new Error(`Provided invalid format to convert: ${e}`);const i=(0,o.getMeridiemComponents)(e),r=(e=>e.hour%12+(e.period===m.Meridiem.PM?12:0))(i);return d=r,M=i.minute,`${(0,n.padTimeNumber)(d)}:${(0,n.padTimeNumber)(M)}`;var d,M},i.convertCivilToMilitary=i.convertMeridiemToMilitary,i.convert12To24=i.convertMeridiemToMilitary,i.toMilitary=i.convertMeridiemToMilitary;i.convertMilitaryToMeridiem=e=>{if(!(0,t.isMilitaryFormat)(e))throw new Error(`Provided invalid format to convert: ${e}`);const i=(0,o.getMilitaryComponents)(e),r=i.hour%12||12,d=i.hour>=12?m.Meridiem.PM:m.Meridiem.AM;return((e,i,r)=>`${(0,n.padTimeNumber)(e)}:${(0,n.padTimeNumber)(i)} ${r}`)(r,i.minute,d)},i.convertMilitaryToCivil=i.convertMilitaryToMeridiem,i.convert24To12=i.convertMilitaryToMeridiem,i.toMeridiem=i.convertMilitaryToMeridiem},707(e,i){var r;Object.defineProperty(i,"__esModule",{value:!0}),i.TimeComponent=void 0,function(e){e.Hour="hour",e.Minute="minute",e.Period="period"}(r||(i.TimeComponent=r={}))},721(e,i,r){Object.defineProperty(i,"__esModule",{value:!0}),i.isPMPeriodStr=i.isPostNoonPeriodStr=i.isAMPeriodStr=i.isPreNoonPeriodStr=i.isMeridiemFormat=i.isMilitaryFormat=void 0;const t=r(239);i.isMilitaryFormat=e=>t.MilitaryTimeRegex.test(e);i.isMeridiemFormat=e=>t.MeridiemTimeRegex.test(e);i.isPreNoonPeriodStr=e=>t.AMPeriodRegex.test(e),i.isAMPeriodStr=i.isPreNoonPeriodStr;i.isPostNoonPeriodStr=e=>t.PMPeriodRegex.test(e),i.isPMPeriodStr=i.isPostNoonPeriodStr},729(e,i,r){var t=this&&this.__createBinding||(Object.create?function(e,i,r,t){void 0===t&&(t=r);var o=Object.getOwnPropertyDescriptor(i,r);o&&!("get"in o?!i.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return i[r]}}),Object.defineProperty(e,t,o)}:function(e,i,r,t){void 0===t&&(t=r),e[t]=i[r]}),o=this&&this.__exportStar||function(e,i){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(i,r)||t(i,e,r)};Object.defineProperty(i,"__esModule",{value:!0}),o(r(550),i),o(r(707),i),o(r(51),i),o(r(542),i),o(r(331),i),o(r(721),i),o(r(704),i),o(r(492),i),o(r(63),i)}},i={};var r=function r(t){var o=i[t];if(void 0!==o)return o.exports;var n=i[t]={exports:{}};return e[t].call(n.exports,n,n.exports,r),n.exports}(729);return r})());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libchrono/time",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Small library to handle time format conversion.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",