Skip to content

Commit a1a346b

Browse files
StartAutomatingStartAutomating
authored andcommitted
Join-PipeScript: Improving Unnamed end block behavior (Fixes #363)
1 parent be65dea commit a1a346b

1 file changed

Lines changed: 41 additions & 35 deletions

File tree

docs/OutputFile.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
OutputFile
22
----------
3+
4+
5+
6+
37
### Synopsis
48
Outputs to a File
59

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

917
Outputs the result of a script into a file.
1018

19+
20+
1121
---
22+
23+
1224
### Examples
1325
#### EXAMPLE 1
1426
```PowerShell
@@ -26,126 +38,120 @@ Invoke-PipeScript {
2638
$Message = 'hello world'
2739
[Save(".\Hello.txt")]$Message
2840
}
41+
42+
2943
---
44+
45+
3046
### Parameters
3147
#### **OutputPath**
3248

3349
The Output Path
3450

3551

3652

37-
> **Type**: ```[String]```
3853

39-
> **Required**: true
4054

41-
> **Position**: 1
4255

43-
> **PipelineInput**:false
56+
|Type |Required|Position|PipelineInput|
57+
|----------|--------|--------|-------------|
58+
|`[String]`|true |1 |false |
4459

4560

4661

47-
---
4862
#### **ScriptBlock**
4963

5064
The Script Block that will be run.
5165

5266

5367

54-
> **Type**: ```[ScriptBlock]```
5568

56-
> **Required**: false
5769

58-
> **Position**: 2
5970

60-
> **PipelineInput**:true (ByValue)
71+
|Type |Required|Position|PipelineInput |
72+
|---------------|--------|--------|--------------|
73+
|`[ScriptBlock]`|false |2 |true (ByValue)|
6174

6275

6376

64-
---
6577
#### **VariableAst**
6678

67-
> **Type**: ```[VariableExpressionAst]```
6879

69-
> **Required**: false
7080

71-
> **Position**: 3
7281

73-
> **PipelineInput**:true (ByValue)
82+
|Type |Required|Position|PipelineInput |
83+
|-------------------------|--------|--------|--------------|
84+
|`[VariableExpressionAst]`|false |3 |true (ByValue)|
7485

7586

7687

77-
---
7888
#### **Encoding**
7989

8090
The encoding parameter.
8191

8292

8393

84-
> **Type**: ```[String]```
8594

86-
> **Required**: false
8795

88-
> **Position**: 4
8996

90-
> **PipelineInput**:false
97+
|Type |Required|Position|PipelineInput|
98+
|----------|--------|--------|-------------|
99+
|`[String]`|false |4 |false |
91100

92101

93102

94-
---
95103
#### **Force**
96104

97105
If set, will force output, overwriting existing files.
98106

99107

100108

101-
> **Type**: ```[Switch]```
102109

103-
> **Required**: false
104110

105-
> **Position**: named
106111

107-
> **PipelineInput**:false
112+
|Type |Required|Position|PipelineInput|
113+
|----------|--------|--------|-------------|
114+
|`[Switch]`|false |named |false |
108115

109116

110117

111-
---
112118
#### **ExportScript**
113119

114120
The export script
115121

116122

117123

118-
> **Type**: ```[ScriptBlock]```
119124

120-
> **Required**: false
121125

122-
> **Position**: 5
123126

124-
> **PipelineInput**:false
127+
|Type |Required|Position|PipelineInput|
128+
|---------------|--------|--------|-------------|
129+
|`[ScriptBlock]`|false |5 |false |
125130

126131

127132

128-
---
129133
#### **Depth**
130134

131135
The serialization depth. Currently only used when saving to JSON files.
132136

133137

134138

135-
> **Type**: ```[Int32]```
136139

137-
> **Required**: false
138140

139-
> **Position**: 6
140141

141-
> **PipelineInput**:false
142+
|Type |Required|Position|PipelineInput|
143+
|---------|--------|--------|-------------|
144+
|`[Int32]`|false |6 |false |
145+
146+
142147

143148

144149

145150
---
151+
152+
146153
### Syntax
147154
```PowerShell
148155
OutputFile [-OutputPath] <String> [[-ScriptBlock] <ScriptBlock>] [[-VariableAst] <VariableExpressionAst>] [[-Encoding] <String>] [-Force] [[-ExportScript] <ScriptBlock>] [[-Depth] <Int32>] [<CommonParameters>]
149156
```
150-
---
151157

0 commit comments

Comments
 (0)