Skip to content

Commit a1d31f6

Browse files
committed
(doc) WIP - Add docs for Assert-ValidChecksum
1 parent b160156 commit a1d31f6

File tree

1 file changed

+138
-0
lines changed

1 file changed

+138
-0
lines changed
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
external help file: Chocolatey.PowerShell.dll-Help.xml
3+
Module Name: Chocolatey.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
import Xref from '@components/Xref.astro';
8+
9+
# Assert-ValidChecksum
10+
11+
## SYNOPSIS
12+
{{ Fill in the Synopsis }}
13+
14+
## SYNTAX
15+
16+
```
17+
Assert-ValidChecksum [-Path] <String> [[-Checksum] <String>] [[-ChecksumType] <ChecksumType>] [[-Url] <String>]
18+
[-IgnoredArguments <Object[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
{{ Fill in the Description }}
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
```powershell
28+
PS C:\> {{ Add example code here }}
29+
```
30+
31+
{{ Add example description here }}
32+
33+
## PARAMETERS
34+
35+
### -Checksum
36+
{{ Fill Checksum Description }}
37+
38+
```yaml
39+
Type: String
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: False
44+
Position: 1
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -ChecksumType
51+
{{ Fill ChecksumType Description }}
52+
53+
```yaml
54+
Type: ChecksumType
55+
Parameter Sets: (All)
56+
Aliases:
57+
Accepted values: Md5, Sha1, Sha256, Sha512
58+
59+
Required: False
60+
Position: 2
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -IgnoredArguments
67+
{{ Fill IgnoredArguments Description }}
68+
69+
```yaml
70+
Type: Object[]
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Path
82+
{{ Fill Path Description }}
83+
84+
```yaml
85+
Type: String
86+
Parameter Sets: (All)
87+
Aliases: File, FilePath
88+
89+
Required: True
90+
Position: 0
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -Url
97+
{{ Fill Url Description }}
98+
99+
```yaml
100+
Type: String
101+
Parameter Sets: (All)
102+
Aliases: OriginalUrl
103+
104+
Required: False
105+
Position: 3
106+
Default value: None
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -ProgressAction
112+
{{ Fill ProgressAction Description }}
113+
114+
```yaml
115+
Type: ActionPreference
116+
Parameter Sets: (All)
117+
Aliases: proga
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### CommonParameters
127+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
128+
129+
## INPUTS
130+
131+
### System.Object[]
132+
133+
## OUTPUTS
134+
135+
### System.Object
136+
## NOTES
137+
138+
## RELATED LINKS

0 commit comments

Comments
 (0)