PowerShell/Docs/set-timer.md
2023-05-26 12:20:18 +02:00

72 lines
1.6 KiB
Markdown

## The *set-timer.ps1* Script
This PowerShell script sets a timer for a countdown.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/set-timer.ps1 [[-Seconds] <Int32>] [<CommonParameters>]
-Seconds <Int32>
Specifies the number of seconds
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./set-timer 60
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Sets a timer for a countdown
.DESCRIPTION
This PowerShell script sets a timer for a countdown.
.PARAMETER Seconds
Specifies the number of seconds
.EXAMPLE
PS> ./set-timer 60
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([int]$Seconds = 0)
try {
if ($Seconds -eq 0 ) { [int]$Seconds = read-host "Enter number of seconds" }
for ($i = $Seconds; $i -gt 0; $i--) {
Clear-Host
./write-big "T-$i seconds"
Start-Sleep -seconds 1
}
"✔️ $Seconds seconds countdown finished"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of set-timer.ps1*