@libchrono/time 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/dist/calculations.d.ts +30 -0
- package/dist/generators.d.ts +32 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -1
- package/package.json +26 -26
package/README.md
CHANGED
|
@@ -77,6 +77,20 @@ console.log(getMeridiemComponents('11:45 PM')); // Output: { hour: 11, minute: 4
|
|
|
77
77
|
console.log(getMilitaryComponents('23:45')); // Output: { hour: 23, minute: 45 }
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
+
### Get times labels in military format
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
console.log(getMilitaryTimes('00:00', '23:59', 10)) // Output: ['00:00', '00:10', '00:20', ... '23:50']
|
|
84
|
+
console.log(getMeridiemTimes('08:30 AM', '12:00 PM', 30)) // Output: ['08:30 AM', '09:00 AM', '09:30 AM', ..., '12:00 PM']
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Calculate seconds in time window
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
calculateMilitaryTimeWindowInSec('08:00', '12:00'); // 14400
|
|
91
|
+
calculateMeridiemTimeWindowInSec('8:00 AM', '12:00 PM'); // 14400
|
|
92
|
+
```
|
|
93
|
+
|
|
80
94
|
[Full documentation](./docs/globals.md)
|
|
81
95
|
|
|
82
96
|
## 🛠️ Why Use @libchrono/time
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Calculates the time window length in seconds between two **military** time strings (`HH:mm`).
|
|
3
|
+
*
|
|
4
|
+
* @example
|
|
5
|
+
* ```ts
|
|
6
|
+
* calculateMilitaryTimeWindowInSec('08:00', '12:00'); // 14400
|
|
7
|
+
* ```
|
|
8
|
+
*
|
|
9
|
+
* @param startStr - Start time in `HH:mm` format.
|
|
10
|
+
* @param endStr - End time in `HH:mm` format.
|
|
11
|
+
* @returns The number of seconds between start and end.
|
|
12
|
+
* @throws {@link Error} If end time is before start time.
|
|
13
|
+
*/
|
|
14
|
+
export declare const calculateMilitaryTimeWindowInSec: (startStr: string, endStr: string) => number;
|
|
15
|
+
/**
|
|
16
|
+
* Calculates the time window length in seconds between two **meridiem** time strings (e.g. `8:00 AM`).
|
|
17
|
+
*
|
|
18
|
+
* The inputs are converted to military format and parsed into components before calculating the delta.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* calculateMeridiemTimeWindowInSec('8:00 AM', '12:00 PM'); // 14400
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @param startStr - Start time in meridiem format (e.g. `8:00 AM`).
|
|
26
|
+
* @param endStr - End time in meridiem format (e.g. `12:00 PM`).
|
|
27
|
+
* @returns The number of seconds between start and end.
|
|
28
|
+
* @throws {@link Error} If end time is before start time.
|
|
29
|
+
*/
|
|
30
|
+
export declare const calculateMeridiemTimeWindowInSec: (startStr: string, endStr: string) => number;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generates a list of times using **24-hour (military) format**.
|
|
3
|
+
*
|
|
4
|
+
* Example:
|
|
5
|
+
* ```ts
|
|
6
|
+
* getMilitaryTimes('08:00', '12:00', 30);
|
|
7
|
+
* // → ['08:00', '08:30', '09:00', ...]
|
|
8
|
+
* ```
|
|
9
|
+
*
|
|
10
|
+
* @param startStr - Start time in `HH:mm` format
|
|
11
|
+
* @param endStr - End time in `HH:mm` format
|
|
12
|
+
* @param interval - Minute interval (default: 30)
|
|
13
|
+
* @returns An array of formatted time strings
|
|
14
|
+
*/
|
|
15
|
+
export declare const getMilitaryTimes: (startStr: string, endStr: string, interval?: number) => string[];
|
|
16
|
+
/**
|
|
17
|
+
* Generates a list of times using **12-hour (meridiem) format** input.
|
|
18
|
+
*
|
|
19
|
+
* Example:
|
|
20
|
+
* ```ts
|
|
21
|
+
* getMeridiemTimes('8:00 AM', '12:00 PM', 15);
|
|
22
|
+
* // → ['08:00 AM', '08:30 AM', '09:00 AM', ..., '12:00 PM']
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* Internally, times are converted to military components before processing.
|
|
26
|
+
*
|
|
27
|
+
* @param startStr - Start time in meridiem format (e.g. `8:00 AM`)
|
|
28
|
+
* @param endStr - End time in meridiem format (e.g. `12:00 PM`)
|
|
29
|
+
* @param interval - Minute interval (default: 30)
|
|
30
|
+
* @returns An array of formatted time strings in `HH:mm`
|
|
31
|
+
*/
|
|
32
|
+
export declare const getMeridiemTimes: (startStr: string, endStr: string, interval?: number) => string[];
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ export * from "./type/enum/meridiem";
|
|
|
2
2
|
export * from "./type/enum/time-component";
|
|
3
3
|
export * from "./type/meridiem-time-components";
|
|
4
4
|
export * from "./type/military-time-components";
|
|
5
|
+
export * from "./calculations";
|
|
5
6
|
export * from "./checkers";
|
|
6
7
|
export * from "./converters";
|
|
7
8
|
export * from "./extractors";
|
|
9
|
+
export * from "./generators";
|
package/dist/index.js
CHANGED
|
@@ -1 +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,(
|
|
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 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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libchrono/time",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Small library to handle time format conversion.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -37,38 +37,38 @@
|
|
|
37
37
|
"scripts": {
|
|
38
38
|
"build:lib": "webpack && tsc-alias -p tsconfig.json",
|
|
39
39
|
"build:types": "tsc -p tsconfig.type.json && tsc-alias -p tsconfig.type.json",
|
|
40
|
-
"build:all": "
|
|
40
|
+
"build:all": "bun run build:lib && bun run build:types",
|
|
41
41
|
"test": "jest",
|
|
42
|
-
"coverage": "
|
|
43
|
-
"deploy": "
|
|
44
|
-
"docs": "typedoc"
|
|
42
|
+
"coverage": "bun run test --coverage && bunx make-coverage-badge",
|
|
43
|
+
"deploy": "bun run test && bun run build:all && npm publish",
|
|
44
|
+
"docs": "typedoc ./src/index.ts"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@types/jest": "^
|
|
48
|
-
"@types/node": "^
|
|
49
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
50
|
-
"@typescript-eslint/parser": "^8.
|
|
51
|
-
"eslint": "^9.
|
|
52
|
-
"eslint-config-love": "^
|
|
53
|
-
"eslint-config-prettier": "^10.
|
|
54
|
-
"eslint-import-resolver-typescript": "^
|
|
55
|
-
"eslint-plugin-check-file": "^
|
|
56
|
-
"eslint-plugin-import": "^2.
|
|
47
|
+
"@types/jest": "^30.0.0",
|
|
48
|
+
"@types/node": "^24.10.4",
|
|
49
|
+
"@typescript-eslint/eslint-plugin": "^8.52.0",
|
|
50
|
+
"@typescript-eslint/parser": "^8.52.0",
|
|
51
|
+
"eslint": "^9.39.2",
|
|
52
|
+
"eslint-config-love": "^144.0.0",
|
|
53
|
+
"eslint-config-prettier": "^10.1.8",
|
|
54
|
+
"eslint-import-resolver-typescript": "^4.4.4",
|
|
55
|
+
"eslint-plugin-check-file": "^3.3.1",
|
|
56
|
+
"eslint-plugin-import": "^2.32.0",
|
|
57
57
|
"eslint-plugin-max-params-no-constructor": "^0.0.4",
|
|
58
|
-
"eslint-webpack-plugin": "^
|
|
59
|
-
"jest": "^
|
|
58
|
+
"eslint-webpack-plugin": "^5.0.2",
|
|
59
|
+
"jest": "^30.2.0",
|
|
60
60
|
"make-coverage-badge": "^1.2.0",
|
|
61
|
-
"prettier": "^3.4
|
|
62
|
-
"terser-webpack-plugin": "^5.3.
|
|
63
|
-
"ts-jest": "^29.
|
|
64
|
-
"ts-loader": "^9.5.
|
|
61
|
+
"prettier": "^3.7.4",
|
|
62
|
+
"terser-webpack-plugin": "^5.3.16",
|
|
63
|
+
"ts-jest": "^29.4.6",
|
|
64
|
+
"ts-loader": "^9.5.4",
|
|
65
65
|
"ts-node": "^10.9.2",
|
|
66
|
-
"tsc-alias": "^1.8.
|
|
66
|
+
"tsc-alias": "^1.8.16",
|
|
67
67
|
"tsconfig-paths-webpack-plugin": "^4.2.0",
|
|
68
|
-
"typedoc": "^0.
|
|
69
|
-
"typedoc-plugin-markdown": "^4.
|
|
70
|
-
"typescript": "^5.
|
|
71
|
-
"webpack": "^5.
|
|
68
|
+
"typedoc": "^0.28.15",
|
|
69
|
+
"typedoc-plugin-markdown": "^4.9.0",
|
|
70
|
+
"typescript": "^5.9.3",
|
|
71
|
+
"webpack": "^5.104.1",
|
|
72
72
|
"webpack-cli": "^6.0.1"
|
|
73
73
|
}
|
|
74
74
|
}
|