1.0.0 • Published 11 months ago

@libchrono/time v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

šŸ•’ @libchrono/time

npm version GitHub license npm.io

ā³ 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:

npm install @libchrono/time

or yarn:

yarn add @libchrono/time
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

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

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

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

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

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

šŸ› ļø 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.