Skip to content

Commit 9e1650d

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating Join-PipeScript.md [skip ci]
1 parent be3bf1c commit 9e1650d

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

docs/Join-PipeScript.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
2+
Join-PipeScript
3+
---------------
4+
### Synopsis
5+
Joins PowerShell and PipeScript ScriptBlocks
6+
7+
---
8+
### Description
9+
10+
Joins ScriptBlocks written in PowerShell or PipeScript.
11+
12+
---
13+
### Related Links
14+
* [Update-PipeScript](Update-PipeScript.md)
15+
---
16+
### Examples
17+
#### EXAMPLE 1
18+
```PowerShell
19+
Get-Command Join-PipeScript | Join-PipeScript
20+
```
21+
22+
---
23+
### Parameters
24+
#### **ScriptBlock**
25+
26+
A ScriptBlock written in PowerShell or PipeScript.
27+
28+
29+
30+
|Type |Requried|Postion|PipelineInput |
31+
|---------------------|--------|-------|------------------------------|
32+
|```[ScriptBlock[]]```|true |named |true (ByValue, ByPropertyName)|
33+
---
34+
#### **SkipBlockType**
35+
36+
A list of block types to be skipped during a merge of script blocks.
37+
By default, no blocks will be skipped
38+
39+
40+
41+
Valid Values:
42+
43+
* using
44+
* requires
45+
* help
46+
* param
47+
* dynamicParam
48+
* begin
49+
* process
50+
* end
51+
|Type |Requried|Postion|PipelineInput|
52+
|----------------|--------|-------|-------------|
53+
|```[String[]]```|false |named |false |
54+
---
55+
#### **BlockType**
56+
57+
A list of block types to include during a merge of script blocks.
58+
59+
60+
61+
Valid Values:
62+
63+
* using
64+
* requires
65+
* help
66+
* param
67+
* dynamicParam
68+
* begin
69+
* process
70+
* end
71+
|Type |Requried|Postion|PipelineInput|
72+
|----------------|--------|-------|-------------|
73+
|```[String[]]```|false |named |false |
74+
---
75+
#### **Transpile**
76+
77+
If set, will transpile the joined ScriptBlock.
78+
79+
80+
81+
|Type |Requried|Postion|PipelineInput|
82+
|--------------|--------|-------|-------------|
83+
|```[Switch]```|false |named |false |
84+
---
85+
### Syntax
86+
```PowerShell
87+
Join-PipeScript -ScriptBlock <ScriptBlock[]> [-SkipBlockType <String[]>] [-BlockType <String[]>] [-Transpile] [<CommonParameters>]
88+
```
89+
---
90+
91+

0 commit comments

Comments
 (0)