Add formatDuration function - #119
Merged
Samarth2190 merged 1 commit intoOct 13, 2025
Merged
Conversation
…ns into human-readable strings
Samarth2190
approved these changes
Oct 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes
Implemented a new formatDuration(input, options?) utility function that converts durations (in seconds or milliseconds) to human-readable strings
Added comprehensive test suite covering basic functionality, formatting options, and error handling
Updated module exports to include the new function
Added documentation to the README
Why This Change Is Needed
This enhancement adds a commonly requested utility for working with time durations. The function intelligently formats durations by:
Displaying only non-zero units (unless duration is 0)
Supporting hours, minutes, seconds, and milliseconds
Providing customization options for output format
Handling edge cases appropriately
This addition makes working with time-based data more user-friendly and reduces the need for custom formatting logic in consuming applications.
Test image:
Breaking Changes
None. This is a new utility function that doesn't modify any existing functionality.