Skip to content

Commit 487dd06

Browse files
Nick RodriguezNick Rodriguez
Nick Rodriguez
authored and
Nick Rodriguez
committed
Added advanced function comments
1 parent 7ca0735 commit 487dd06

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

Write-Type.ps1

+27
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,31 @@
11
function Write-Type {
2+
<#
3+
.Synopsis
4+
Make Write-Host text appear as if it is being typed
5+
6+
.DESCRIPTION
7+
Input text and if desired specify the write speed (25-500 milliseconds) and foreground color for the text
8+
9+
.EXAMPLE
10+
Write-Typewriter 'Hello world!'
11+
12+
.EXAMPLE
13+
Write-Typewriter 'Hello world!' 250
14+
15+
.EXAMPLE
16+
Write-Typewriter -Text '2 spooky 4 me!' -TypeSpeed 400 -ForegroundColor 'Red'
17+
18+
.NOTES
19+
v1.1 - 2016-04-04 - Nick Rodriguez
20+
-Changed name
21+
-Changed TypeSpeed range
22+
-Added ForegroundColor param
23+
-Changed sleep to not use method after seeing it slow performance with Measure-Command
24+
-Changed code formatting to my liking
25+
26+
v1.0 - 2016-01-25 - Nathan Kasco (http://poshcode.org/6193)
27+
#>
28+
229
[CmdletBinding()]
330
[OutputType([string])]
431

0 commit comments

Comments
 (0)