Skip to content

Commit 88fb481

Browse files
StartAutomatingStartAutomating
authored andcommitted
Create FUNDING.yml
1 parent e5f3cdb commit 88fb481

1 file changed

Lines changed: 37 additions & 12 deletions

File tree

docs/Export-RegEx.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
Export-RegEx
22
------------
3+
4+
5+
6+
37
### Synopsis
48
Exports a RegEx
59

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

917
Exports one or more Regular Expressions
1018

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

@@ -18,7 +30,11 @@ Exports one or more Regular Expressions
1830

1931

2032

33+
34+
2135
---
36+
37+
2238
### Examples
2339
#### EXAMPLE 1
2440
```PowerShell
@@ -30,7 +46,11 @@ Export-RegEx -Name Digits, Decimals -Path $home\MyRegExs
3046
Export-RegEx -Name Digits, Decimals -As Script # Creates a script that embedes the expressions and Use-RegEx
3147
```
3248

49+
50+
3351
---
52+
53+
3454
### Parameters
3555
#### **Name**
3656

@@ -47,7 +67,6 @@ The name of the regular expression. If not provided, this can be inferred if th
4767

4868

4969

50-
---
5170
#### **Path**
5271

5372
The export path.
@@ -64,7 +83,6 @@ If this is not provided, it will export regular expressions to the user's Irregu
6483

6584

6685

67-
---
6886
#### **As**
6987

7088
How the expression will be exported.
@@ -96,7 +114,6 @@ Valid Values:
96114

97115

98116

99-
---
100117
#### **Noun**
101118

102119
If provided, will rename -RegEx commands with the provided -Noun.
@@ -114,27 +131,35 @@ It prevents name conflicts with Irregular.
114131

115132

116133

117-
---
118134
#### **WhatIf**
119135
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
120136
-WhatIf is used to see what would happen, or return operations without executing them
121137
#### **Confirm**
122138
-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
123139
-Confirm is used to -Confirm each operation.
124-
140+
125141
If you pass ```-Confirm:$false``` you will not be prompted.
126-
127-
142+
143+
128144
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
129145

146+
147+
130148
---
131-
### Syntax
132-
```PowerShell
133-
Export-RegEx [[-Name] <String[]>] [[-Path] <String>] [[-As] <String>] [[-Noun] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
134-
```
135-
---
149+
150+
136151
### Notes
137152
When exporting as a script, Use-RegEx is renamed to UseRegex.
138153
This enables embedding the core of Irregular and your Regular Expressions into a module while making it easy to avoid exporting Irregular.
139154

140155
To use this within a module, make sure your module explicitly exports commands, or exports with a wildcard like '*-*'.
156+
157+
158+
159+
---
160+
161+
162+
### Syntax
163+
```PowerShell
164+
Export-RegEx [[-Name] <String[]>] [[-Path] <String>] [[-As] <String>] [[-Noun] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
165+
```

0 commit comments

Comments
 (0)