11Get-RegEx
22---------
33
4-
5-
6-
74### Synopsis
85Gets Regular Expressions
96
10-
11-
127---
138
14-
159### Description
1610
1711Gets saved Regular Expressions.
1812
19-
20-
2113---
2214
23-
2415### Related Links
2516* [ Use-RegEx] ( Use-RegEx.md )
2617
27-
28-
2918* [ New-RegEx] ( New-RegEx.md )
3019
31-
32-
33-
34-
3520---
3621
37-
3822### Examples
39- #### EXAMPLE 1
23+ > EXAMPLE 1
24+
4025``` PowerShell
4126Get-RegEx
4227```
28+ > EXAMPLE 2
4329
44- #### EXAMPLE 2
4530``` PowerShell
4631Get-RegEx -Name NextWord
4732```
33+ > EXAMPLE 3
4834
49- #### EXAMPLE 3
5035``` PowerShell
5136@(Get-RegEx | # Gets all saved Regular Expressions as a Markdown table
5237 Sort-Object Name |
@@ -60,64 +45,33 @@ Get-RegEx -Name NextWord
6045 }) -join [Environment]::NewLine
6146```
6247
63-
64-
6548---
6649
67-
6850### Parameters
6951#### ** Name**
70-
7152The Name of the Regular Expression.
7253
73-
74-
75-
76-
77-
7854| Type | Required| Position| PipelineInput |
7955| ------------| --------| --------| ---------------------|
8056| ` [String[]] ` | false | 1 | true (ByPropertyName)|
8157
82-
83-
8458#### ** FilePath**
85-
8659The path to one or more files or folders containing regular expressions.
8760Files should be named $Name.regex.txt
8861
89-
90-
91-
92-
93-
9462| Type | Required| Position| PipelineInput | Aliases |
9563| ------------| --------| --------| ---------------------| --------|
9664| ` [String[]] ` | false | 2 | true (ByPropertyName)| Fullname|
9765
98-
99-
10066#### ** FromModule**
101-
10267If provided, will get regular expressions from any number of already imported modules.
10368
104-
105-
106-
107-
108-
10969| Type | Required| Position| PipelineInput|
11070| ------------| --------| --------| -------------|
11171| ` [String[]] ` | false | 3 | false |
11272
113-
114-
11573#### ** As**
116-
11774How the expression will be returned.
118-
119-
120-
12175Valid Values:
12276
12377* Metadata
@@ -132,50 +86,26 @@ Valid Values:
13286* Engine
13387* Embedded
13488
135-
136-
137-
138-
139-
14089| Type | Required| Position| PipelineInput|
14190| ----------| --------| --------| -------------|
14291| ` [String] ` | false | 4 | false |
14392
144-
145-
14693#### ** Noun**
147-
14894If provided, will rename -RegEx commands with the provided -Noun.
14995This option is only valid when -As is Engine.
15096It prevents name conflicts with Irregular.
15197
152-
153-
154-
155-
156-
15798| Type | Required| Position| PipelineInput|
15899| ----------| --------| --------| -------------|
159100| ` [String] ` | false | 5 | false |
160101
161-
162-
163-
164-
165102---
166103
167-
168104### Outputs
169105* [ Management.Automation.PSObject] ( https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject )
170106
171-
172-
173-
174-
175-
176107---
177108
178-
179109### Syntax
180110``` PowerShell
181111Get-RegEx [[-Name] <String[]>] [[-FilePath] <String[]>] [[-FromModule] <String[]>] [[-As] <String>] [[-Noun] <String>] [<CommonParameters>]
0 commit comments