Skip to content

Commit 0e8dfe7

Browse files
StartAutomatingStartAutomating
authored andcommitted
Create FUNDING.yml
1 parent 8827b5f commit 0e8dfe7

1 file changed

Lines changed: 31 additions & 11 deletions

File tree

docs/Set-RegEx.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
11
Set-RegEx
22
---------
3+
4+
5+
6+
37
### Synopsis
48
Sets a Regular Expression
59

10+
11+
612
---
13+
14+
715
### Description
816

917
Sets Regular Expressions to a .regex.txt file
1018

19+
20+
1121
---
22+
23+
1224
### Related Links
1325
* [Use-RegEx](Use-RegEx.md)
1426

1527

1628

29+
30+
1731
---
32+
33+
1834
### Examples
1935
#### EXAMPLE 1
2036
```PowerShell
2137
New-RegEx -Name Digits -CharacterClass Digit -Repeat |
2238
Set-RegEx
2339
```
2440

41+
42+
2543
---
44+
45+
2646
### Parameters
2747
#### **Pattern**
2848

@@ -39,7 +59,6 @@ The regular expression.
3959

4060

4161

42-
---
4362
#### **Name**
4463

4564
The name of the regular expression. If not provided, this can be inferred if the pattern starts with a capture
@@ -55,7 +74,6 @@ The name of the regular expression. If not provided, this can be inferred if th
5574

5675

5776

58-
---
5977
#### **Description**
6078

6179
The description
@@ -71,7 +89,6 @@ The description
7189

7290

7391

74-
---
7592
#### **Path**
7693

7794
The path to the file. If this is not provided, it will save regular expressions to the user's Irregular module path.
@@ -87,7 +104,6 @@ The path to the file. If this is not provided, it will save regular expressions
87104

88105

89106

90-
---
91107
#### **Temporary**
92108

93109
If set, will not save the regular expression to disk. Instead, it will alter the in-memory RegEx library.
@@ -104,7 +120,6 @@ To use the alias immediately, call Set-RegEx with the . operator (e.g. . Set-Reg
104120

105121

106122

107-
---
108123
#### **TimeOut**
109124

110125
The timeout for the regular expression.
@@ -122,7 +137,6 @@ By default, this is 5 seconds
122137

123138

124139

125-
---
126140
#### **PassThru**
127141

128142
If set, will output created files or commands.
@@ -140,29 +154,35 @@ Otherwise, will output the created files.
140154

141155

142156

143-
---
144157
#### **WhatIf**
145158
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
146159
-WhatIf is used to see what would happen, or return operations without executing them
147160
#### **Confirm**
148161
-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
149162
-Confirm is used to -Confirm each operation.
150-
163+
151164
If you pass ```-Confirm:$false``` you will not be prompted.
152-
153-
165+
166+
154167
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
155168

169+
170+
156171
---
172+
173+
157174
### Outputs
158175
* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable)
159176

160177

161178

162179

180+
181+
163182
---
183+
184+
164185
### Syntax
165186
```PowerShell
166187
Set-RegEx [-Pattern] <String> [[-Name] <String>] [-Description <String>] [-Path <String>] [-Temporary] [-TimeOut <TimeSpan>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
167188
```
168-
---

0 commit comments

Comments
 (0)