@libchrono/time 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Damian Wileński
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# 🕒 @libchrono/time
+
+[![npm version](https://badge.fury.io/js/@libchrono%2Ftime.svg)](https://badge.fury.io/js/@libchrono%2Ftime)
+[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE)
+![](coverage/badge.svg)
+
+## ⏳ Simple Time Format Converter
+
+@libchrono/time is a lightweight and zero-dependency JavaScript library that helps you effortlessly:
+
+✅ Convert 24-hour (military) time to 12-hour (meridiem) time
+
+✅ Convert 12-hour (meridiem) time to 24-hour (military) time
+
+✅ Validate if a string is a valid military or civilian time format
+
+✅ Extract each component of time string in both formats
+
+## 📦 Installation
+
+To use @libchrono/time in your project, install it via npm:
+
+```bash
+npm install @libchrono/time
+```
+
+or yarn:
+
+```bash
+yarn add @libchrono/time
+```
+
+```typescript
+const { convertMeridiemToMilitary } = require('@libchrono/time');
+// or using ES Modules
+import { convertMeridiemToMilitary } from '@libchrono/time';
+
+console.log(convertMeridiemToMilitary('10:00 AM')); // result: 10:00
+```
+
+## 🔧 API Reference
+
+### Convert 24-hour time to 12-hour time
+
+```typescript
+console.log(convertMilitaryToMeridiem('23:45')); // Output: "11:45 PM"
+console.log(convertMilitaryToMeridiem('09:30')); // Output: "9:30 AM"
+```
+
+### Convert 12-hour time to 24-hour time
+
+```typescript
+console.log(convertMeridiemToMilitary('11:45 PM')); // Output: "23:45"
+console.log(convertMeridiemToMilitary('9:30 AM')); // Output: "09:30"
+```
+
+### Validate if a string is in military (24-hour) time format
+
+```typescript
+console.log(isMilitaryFormat('23:45')); // Output: true
+console.log(isMilitaryFormat('11:45 PM')); // Output: false
+console.log(isMilitaryFormat('25:30')); // Output: false (invalid time)
+```
+
+### Validate if a string is in civilian (12-hour) time format
+
+```typescript
+console.log(isMeridiemFormat('11:45 PM')); // Output: true
+console.log(isMeridiemFormat('23:45')); // Output: false
+console.log(isMeridiemFormat('13:30 PM')); // Output: false (invalid time)
+```
+
+### Extract components of the time string
+
+```typescript
+console.log(getMeridiemComponents('11:45 PM')); // Output: { hour: 11, minute: 45, period: 'PM' }
+console.log(getMilitaryComponents('23:45')); // Output: { hour: 23, minute: 45 }
+```
+
+[Full documentation](./docs/globals.md)
+
+## 🛠️ Why Use @libchrono/time
+
+✅ Zero dependencies – lightweight and efficient.
+
+✅ Simple API – minimal, intuitive functions.
+
+✅ Accurate conversions & validations – ensures correctness.
+
+✅ Fully tested – reliable with unit tests.

package/dist/checkers.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Verifies if provided time string is in valid 24-hour (military) time format
+ * @param value Time string
+ * @returns
+ */
+export declare const isMilitaryFormat: (value: string) => boolean;
+/**
+ * Verifies if provided time string is in valid 12-hour (meridiem) time format
+ * @param value Time string
+ * @returns
+ */
+export declare const isMeridiemFormat: (value: string) => boolean;
+/**
+ * Verifies if provided string is a valid AM period
+ * @param value Period string
+ * @returns
+ */
+export declare const isPreNoonPeriodStr: (value: string) => boolean;
+/**
+ * Verifies if provided string is a valid AM period. Alias for {@link isPreNoonPeriodStr}
+ */
+export declare const isAMPeriodStr: (value: string) => boolean;
+/**
+ * Verifies if provided string is a valid PM period
+ * @param value Period string
+ * @returns
+ */
+export declare const isPostNoonPeriodStr: (value: string) => boolean;
+/**
+ * Verifies if provided string is a valid PM period. Alias for {@link isPostNoonPeriodStr}
+ */
+export declare const isPMPeriodStr: (value: string) => boolean;

package/dist/converters.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Converts 12-hour (meridiem) time string to 24-hour (military) time string.
+ * @param value Meridiem time string
+ * @returns Time in military format
+ */
+export declare const convertMeridiemToMilitary: (value: string) => string;
+/**
+ * Converts 12-hour (meridiem) time string to 24-hour (military) time string.
+ * Alias for {@link convertMeridiemToMilitary}.
+ */
+export declare const convertCivilToMilitary: (value: string) => string;
+/**
+ * Converts 12-hour (meridiem) time string to 24-hour (military) time string.
+ * Alias for {@link convertMeridiemToMilitary}.
+ */
+export declare const convert12To24: (value: string) => string;
+/**
+ * Converts 12-hour (meridiem) time string to 24-hour (military) time string.
+ * Alias for {@link convertMeridiemToMilitary}.
+ */
+export declare const toMilitary: (value: string) => string;
+/**
+ * Converts 24-hour (military) time string to 12-hour (meridiem) time string.
+ * @param value Military time string
+ * @returns Time in meridiem format
+ */
+export declare const convertMilitaryToMeridiem: (value: string) => string;
+/**
+ * Converts 24-hour (military) time string to 12-hour (meridiem) time string.
+ * Alias for {@link convertMilitaryToMeridiem}.
+ */
+export declare const convertMilitaryToCivil: (value: string) => string;
+/**
+ * Converts 24-hour (military) time string to 12-hour (meridiem) time string.
+ * Alias for {@link convertMilitaryToMeridiem}.
+ */
+export declare const convert24To12: (value: string) => string;
+export declare const toMeridiem: (value: string) => string;

package/dist/extractors.d.ts

@@ -0,0 +1,14 @@
+import { MeridiemTimeComponents } from './type/meridiem-time-components';
+import { MilitaryTimeComponents } from './type/military-time-components';
+/**
+ * Extracts time elements from provided valid military time string. If provided string is invalid method should throw error.
+ * @param value Time string
+ * @returns
+ */
+export declare const getMilitaryComponents: (value: string) => MilitaryTimeComponents;
+/**
+ * Extracts time elements from provided valid meridiem time string. If provided string is invalid method should throw error.
+ * @param value Time string
+ * @returns
+ */
+export declare const getMeridiemComponents: (value: string) => MeridiemTimeComponents;

package/dist/index.d.ts

@@ -0,0 +1,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 "./checkers";
+export * from "./converters";
+export * from "./extractors";

package/dist/index.js

@@ -0,0 +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={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},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),d=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===d.Meridiem.PM?12:0))(i);return m=r,M=i.minute,`${(0,n.padTimeNumber)(m)}:${(0,n.padTimeNumber)(M)}`;var m,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,m=i.hour>=12?d.Meridiem.PM:d.Meridiem.AM;return((e,i,r)=>`${(0,n.padTimeNumber)(e)}:${(0,n.padTimeNumber)(i)} ${r}`)(r,i.minute,m)},i.convertMilitaryToCivil=i.convertMilitaryToMeridiem,i.convert24To12=i.convertMilitaryToMeridiem,i.toMeridiem=i.convertMilitaryToMeridiem},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),d=r(707),m=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{[d.TimeComponent.Hour]:parseInt(i[1],10),[d.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{[d.TimeComponent.Hour]:parseInt(i[1],10),[d.TimeComponent.Minute]:parseInt(i[2],10),[d.TimeComponent.Period]:m(i[3])}}},729:function(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)},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},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},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={}))},51:(e,i,r)=>{Object.defineProperty(i,"__esModule",{value:!0});r(707)},542:(e,i,r)=>{Object.defineProperty(i,"__esModule",{value:!0});r(707)},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}`}}},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})()));

package/dist/regexps.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Match the military format with option to select hours at 1 index and minutes and 2 index.
+ */
+export declare const MilitaryTimeRegex: RegExp;
+/**
+ * Match the meridiem format with option to select hours at 1 index, minutes at 2 index and period at 3 index.
+ */
+export declare const MeridiemTimeRegex: RegExp;
+/**
+ * Match the ante-meridiem (pre-noon) period name.
+ */
+export declare const AMPeriodRegex: RegExp;
+/**
+ * Match the post-meridiem (post-noon) period name.
+ */
+export declare const PMPeriodRegex: RegExp;

package/dist/type/enum/meridiem.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Enumerator representing periods in 12-hour (meridiem) time.
+ */
+export declare enum Meridiem {
+    /**
+     * Value representing pre-noon (ante-meridiem).
+     */
+    AM = "AM",
+    /**
+     * Value representing pre-noon (post-meridiem).
+     */
+    PM = "PM"
+}
+/**
+ * Enumerator representing periods in 12-hour (meridiem) time. Alias for {@link Meridiem}.
+ */
+export declare enum DayPeriod {
+    AM = "AM",
+    PM = "PM"
+}
+/**
+ * Enumerator representing periods in 12-hour (meridiem) time. Alias for {@link Meridiem}.
+ */
+export declare enum TimeOfDay {
+    AM = "AM",
+    PM = "PM"
+}
+/**
+ * Enumerator representing periods in 12-hour (meridiem) time. Alias for {@link Meridiem}.
+ */
+export declare enum CivilianTimePeriod {
+    AM = "AM",
+    PM = "PM"
+}

package/dist/type/enum/time-component.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Enumerator representing components from which the time string is built.
+ */
+export declare enum TimeComponent {
+    /**
+     * 00-23 or 1-12
+     */
+    Hour = "hour",
+    /**
+     * 00-59
+     */
+    Minute = "minute",
+    /**
+     * AM or PM
+     */
+    Period = "period"
+}

package/dist/type/meridiem-time-components.d.ts

@@ -0,0 +1,10 @@
+import { TimeComponent } from './enum/time-component';
+import { Meridiem } from './enum/meridiem';
+/**
+ * Model representing components of the meridiem time string.
+ */
+export interface MeridiemTimeComponents {
+    readonly [TimeComponent.Hour]: number;
+    readonly [TimeComponent.Minute]: number;
+    readonly [TimeComponent.Period]: Meridiem;
+}

package/dist/type/military-time-components.d.ts

@@ -0,0 +1,8 @@
+import { TimeComponent } from './enum/time-component';
+/**
+ * Model representing components of the military time string.
+ */
+export interface MilitaryTimeComponents {
+    readonly [TimeComponent.Hour]: number;
+    readonly [TimeComponent.Minute]: number;
+}

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Method add `0` prefix for numbers that have only one character. Should throw error when provided value is negative.
+ * @param value Time number
+ * @returns
+ */
+export declare const padTimeNumber: (value: number) => string;

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@libchrono/time",
+  "version": "1.0.0",
+  "description": "Small library to handle time format conversion.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "author": "Damian Wileński",
+  "license": "MIT",
+  "repository": {
+    "url": "git+https://github.com/damianw27/libchrono-time.git"
+  },
+  "keywords": [
+    "time",
+    "convert",
+    "timeformat",
+    "militarytime",
+    "meridiem",
+    "24h",
+    "12h",
+    "timeutils",
+    "timeparser",
+    "timeconversion",
+    "timeformatter",
+    "clock",
+    "hourformat",
+    "timelib",
+    "timekeeper",
+    "timeadjust",
+    "timetools",
+    "timetransform",
+    "timechanger",
+    "timeconvertor"
+  ],
+  "scripts": {
+    "build:lib": "webpack && tsc-alias -p tsconfig.json",
+    "build:types": "tsc -p tsconfig.type.json && tsc-alias -p tsconfig.type.json",
+    "build:all": "yarn build:lib && yarn build:types",
+    "test": "jest",
+    "coverage": "yarn test --coverage && make-coverage-badge",
+    "deploy": "yarn test && yarn build:all && npm publish",
+    "docs": "typedoc"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.12.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
+    "eslint": "^9.19.0",
+    "eslint-config-love": "^118.0.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-check-file": "^2.8.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-max-params-no-constructor": "^0.0.4",
+    "eslint-webpack-plugin": "^4.2.0",
+    "jest": "^29.7.0",
+    "make-coverage-badge": "^1.2.0",
+    "prettier": "^3.4.2",
+    "terser-webpack-plugin": "^5.3.11",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "tsconfig-paths-webpack-plugin": "^4.2.0",
+    "typedoc": "^0.27.6",
+    "typedoc-plugin-markdown": "^4.4.1",
+    "typescript": "^5.7.3",
+    "webpack": "^5.97.1",
+    "webpack-cli": "^6.0.1"
+  }
+}