Skip to content

Commit b56c177

Browse files
StartAutomatingStartAutomating
StartAutomating
authored and
StartAutomating
committed
Merge branch 'PipeScriptNamespaces' of https://github.com/StartAutomating/PipeScript into PipeScriptNamespaces
1 parent 0baf9d3 commit b56c177

File tree

1 file changed

+0
-61
lines changed

1 file changed

+0
-61
lines changed

‎docs/New-PipeScript.md

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,23 @@ New-PipeScript
44

55

66

7-
8-
9-
10-
117
### Synopsis
128
Creates new PipeScript.
139

1410

1511

16-
17-
1812
---
1913

2014

21-
22-
2315
### Description
2416

2517
Creates new PipeScript and PowerShell ScriptBlocks.
2618

2719

2820

29-
30-
3121
---
3222

3323

34-
35-
3624
### Examples
3725
#### EXAMPLE 1
3826
```PowerShell
@@ -65,8 +53,6 @@ New-PipeScript -Parameter @{"bar"=@{
6553
---
6654

6755

68-
69-
7056
### Parameters
7157
#### **Parameter**
7258

@@ -81,9 +67,6 @@ Parameters can be defined in a few ways:
8167

8268

8369

84-
|Type |Required|Position|PipelineInput |
85-
|----------|--------|--------|---------------------|
86-
|`[Object]`|false |1 |true (ByPropertyName)|
8770
|Type |Required|Position|PipelineInput |
8871
|----------|--------|--------|---------------------|
8972
|`[Object]`|false |1 |true (ByPropertyName)|
@@ -99,9 +82,6 @@ The dynamic parameter block.
9982

10083

10184

102-
|Type |Required|Position|PipelineInput |Aliases |
103-
|---------------|--------|--------|---------------------|---------------------|
104-
|`[ScriptBlock]`|false |2 |true (ByPropertyName)|DynamicParameterBlock|
10585
|Type |Required|Position|PipelineInput |Aliases |
10686
|---------------|--------|--------|---------------------|---------------------|
10787
|`[ScriptBlock]`|false |2 |true (ByPropertyName)|DynamicParameterBlock|
@@ -117,9 +97,6 @@ The begin block.
11797

11898

11999

120-
|Type |Required|Position|PipelineInput |Aliases |
121-
|---------------|--------|--------|---------------------|----------|
122-
|`[ScriptBlock]`|false |3 |true (ByPropertyName)|BeginBlock|
123100
|Type |Required|Position|PipelineInput |Aliases |
124101
|---------------|--------|--------|---------------------|----------|
125102
|`[ScriptBlock]`|false |3 |true (ByPropertyName)|BeginBlock|
@@ -135,9 +112,6 @@ The process block.
135112

136113

137114

138-
|Type |Required|Position|PipelineInput |Aliases |
139-
|---------------|--------|--------|---------------------|------------|
140-
|`[ScriptBlock]`|false |4 |true (ByPropertyName)|ProcessBlock|
141115
|Type |Required|Position|PipelineInput |Aliases |
142116
|---------------|--------|--------|---------------------|------------|
143117
|`[ScriptBlock]`|false |4 |true (ByPropertyName)|ProcessBlock|
@@ -153,9 +127,6 @@ The end block.
153127

154128

155129

156-
|Type |Required|Position|PipelineInput |Aliases |
157-
|---------------|--------|--------|---------------------|--------|
158-
|`[ScriptBlock]`|false |5 |true (ByPropertyName)|EndBlock|
159130
|Type |Required|Position|PipelineInput |Aliases |
160131
|---------------|--------|--------|---------------------|--------|
161132
|`[ScriptBlock]`|false |5 |true (ByPropertyName)|EndBlock|
@@ -171,9 +142,6 @@ The script header.
171142

172143

173144

174-
|Type |Required|Position|PipelineInput |
175-
|----------|--------|--------|---------------------|
176-
|`[String]`|false |6 |true (ByPropertyName)|
177145
|Type |Required|Position|PipelineInput |
178146
|----------|--------|--------|---------------------|
179147
|`[String]`|false |6 |true (ByPropertyName)|
@@ -190,9 +158,6 @@ Parameters will be automatically created for any unassigned variables.
190158

191159

192160

193-
|Type |Required|Position|PipelineInput|Aliases |
194-
|----------|--------|--------|-------------|-----------------------------------|
195-
|`[Switch]`|false |named |false |AutoParameterize<br/>AutoParameters|
196161
|Type |Required|Position|PipelineInput|Aliases |
197162
|----------|--------|--------|-------------|-----------------------------------|
198163
|`[Switch]`|false |named |false |AutoParameterize<br/>AutoParameters|
@@ -209,9 +174,6 @@ By default, ```[PSObject]```.
209174

210175

211176

212-
|Type |Required|Position|PipelineInput|
213-
|--------|--------|--------|-------------|
214-
|`[Type]`|false |7 |false |
215177
|Type |Required|Position|PipelineInput|
216178
|--------|--------|--------|-------------|
217179
|`[Type]`|false |7 |false |
@@ -227,9 +189,6 @@ If provided, will add inline help to parameters.
227189

228190

229191

230-
|Type |Required|Position|PipelineInput|
231-
|---------------|--------|--------|-------------|
232-
|`[IDictionary]`|false |8 |false |
233192
|Type |Required|Position|PipelineInput|
234193
|---------------|--------|--------|-------------|
235194
|`[IDictionary]`|false |8 |false |
@@ -249,9 +208,6 @@ If set, will weakly type parameters generated by reflection.
249208

250209

251210

252-
|Type |Required|Position|PipelineInput|Aliases |
253-
|----------|--------|--------|-------------|--------------------------------------------------------------------------------------------------|
254-
|`[Switch]`|false |named |false |WeakType<br/>WeakParameters<br/>WeaklyTypedParameters<br/>WeakProperties<br/>WeaklyTypedProperties|
255211
|Type |Required|Position|PipelineInput|Aliases |
256212
|----------|--------|--------|-------------|--------------------------------------------------------------------------------------------------|
257213
|`[Switch]`|false |named |false |WeakType<br/>WeakParameters<br/>WeaklyTypedParameters<br/>WeakProperties<br/>WeaklyTypedProperties|
@@ -267,9 +223,6 @@ The name of the function to create.
267223

268224

269225

270-
|Type |Required|Position|PipelineInput|
271-
|----------|--------|--------|-------------|
272-
|`[String]`|false |9 |false |
273226
|Type |Required|Position|PipelineInput|
274227
|----------|--------|--------|-------------|
275228
|`[String]`|false |9 |false |
@@ -301,9 +254,6 @@ A description of the script's functionality. If provided with -Synopsis, will g
301254

302255

303256

304-
|Type |Required|Position|PipelineInput|
305-
|----------|--------|--------|-------------|
306-
|`[String]`|false |11 |false |
307257
|Type |Required|Position|PipelineInput|
308258
|----------|--------|--------|-------------|
309259
|`[String]`|false |11 |false |
@@ -319,9 +269,6 @@ A short synopsis of the script's functionality. If provided with -Description,
319269

320270

321271

322-
|Type |Required|Position|PipelineInput|
323-
|----------|--------|--------|-------------|
324-
|`[String]`|false |12 |false |
325272
|Type |Required|Position|PipelineInput|
326273
|----------|--------|--------|-------------|
327274
|`[String]`|false |12 |false |
@@ -337,9 +284,6 @@ A list of examples to use in help. Will be ignored if -Synopsis and -Descriptio
337284

338285

339286

340-
|Type |Required|Position|PipelineInput|Aliases |
341-
|------------|--------|--------|-------------|--------|
342-
|`[String[]]`|false |13 |false |Examples|
343287
|Type |Required|Position|PipelineInput|Aliases |
344288
|------------|--------|--------|-------------|--------|
345289
|`[String[]]`|false |13 |false |Examples|
@@ -355,9 +299,6 @@ A list of links to use in help. Will be ignored if -Synopsis and -Description a
355299

356300

357301

358-
|Type |Required|Position|PipelineInput|Aliases|
359-
|------------|--------|--------|-------------|-------|
360-
|`[String[]]`|false |14 |false |Links |
361302
|Type |Required|Position|PipelineInput|Aliases|
362303
|------------|--------|--------|-------------|-------|
363304
|`[String[]]`|false |14 |false |Links |
@@ -399,8 +340,6 @@ If set, will not transpile the created code.
399340
---
400341

401342

402-
403-
404343
### Syntax
405344
```PowerShell
406345
New-PipeScript [[-Parameter] <Object>] [[-DynamicParameter] <ScriptBlock>] [[-Begin] <ScriptBlock>] [[-Process] <ScriptBlock>] [[-End] <ScriptBlock>] [[-Header] <String>] [-AutoParameter] [[-AutoParameterType] <Type>] [[-ParameterHelp] <IDictionary>] [-WeaklyTyped] [[-FunctionName] <String>] [[-FunctionType] <String>] [[-Description] <String>] [[-Synopsis] <String>] [[-Example] <String[]>] [[-Link] <String[]>] [[-Attribute] <String[]>] [-NoTranspile] [<CommonParameters>]

0 commit comments

Comments
 (0)