A PowerShell module to manage and build functionality on top of the TimeSpan object.
This module uses the PSModule framework for building, testing and publishing the module.
To install the module from the PowerShell Gallery, you can use the following commands:
Install-PSResource -Name TimeSpan
Import-Module -Name TimeSpanThis example shows the default behavior of Format-TimeSpan, which converts TimeSpan objects into human-readable formatted strings showing all units that have non-zero values.
New-TimeSpan -Hours 2 -Minutes 30 -Seconds 10 | Format-TimeSpan -Format FullName
# Output: 2 hours 30 minutes 10 secondsUse the IncludeZeroValues parameter to include units with zero values in the output, showing all time units from the highest non-zero unit down to the smallest unit.
New-TimeSpan -Hours 2 -Minutes 30 -Seconds 10 | Format-TimeSpan -Format FullName -IncludeZeroValues
# Output: 2 hours 30 minutes 10 seconds 0 milliseconds 0 microsecondsThe Format-TimeSpan function supports three different format styles to display time units in various ways.
# Symbol format (default)
New-TimeSpan -Minutes 90 | Format-TimeSpan
# Output: 1h 30m
# Abbreviation format
New-TimeSpan -Minutes 90 | Format-TimeSpan -Format Abbreviation
# Output: 1hr 30min
# Full name format
New-TimeSpan -Minutes 90 | Format-TimeSpan -Format FullName
# Output: 1 hour 30 minutesYou can specify an exact number of time units to display using the Precision parameter, which maintains backward compatibility with previous versions.
# Show only the most significant unit (rounded)
New-TimeSpan -Minutes 90 | Format-TimeSpan -Precision 1
# Output: 2h
# Show specific number of units
[TimeSpan]::FromSeconds(3661) | Format-TimeSpan -Precision 2 -Format FullName
# Output: 1 hour 1 minuteUse the BaseUnit parameter to force formatting from a specific time unit, regardless of the actual values in the TimeSpan.
[TimeSpan]::FromMinutes(2) | Format-TimeSpan -BaseUnit 'Seconds'
# Output: 120sTo find more examples of how to use the module, please refer to the examples folder.
Alternatively, you can use Get-Command -Module TimeSpan to find more commands that are available in the module.
To find examples of each of the commands you can use Get-Help -Examples Format-TimeSpan.
The module supports formatting for the following time units (from largest to smallest):
| Unit | Singular | Plural | Abbreviation | Symbol |
|---|---|---|---|---|
| Millennia | millennium | millennia | mill | kyr |
| Centuries | century | centuries | cent | c |
| Decades | decade | decades | dec | dec |
| Years | year | years | yr | y |
| Months | month | months | mon | mo |
| Weeks | week | weeks | wk | wk |
| Days | day | days | day | d |
| Hours | hour | hours | hr | h |
| Minutes | minute | minutes | min | m |
| Seconds | second | seconds | sec | s |
| Milliseconds | millisecond | milliseconds | msec | ms |
| Microseconds | microsecond | microseconds | µsec | µs |
For detailed function documentation, use:
Get-Help Format-TimeSpan -Full
Get-Help Format-TimeSpan -OnlineYou can also use the -Online parameter to get the function documentation online. While in VSCode, users can move the cursor to a function and press Shift+F1 to get to the online documentation.
Coder or not, you can contribute to the project! We welcome all contributions.
If you don't code, you still sit on valuable information that can make this project even better. If you experience that the product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. Please see the issues tab on this project and submit a new issue that matches your needs.
If you do code, we'd love to have your contributions. Please read the Contribution guidelines for more information. You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
Here is a list of people and projects that helped this project in some way.