Skip to content

Commit a59dbd3

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating PipeScript.HelpOut.ps1 - auto-documenting Transpilers (#56)
1 parent 177724e commit a59dbd3

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

docs/Include-Transpiler.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
2+
Transpilers/Include.psx.ps1
3+
---------------------------
4+
### Synopsis
5+
Includes Files
6+
7+
---
8+
### Description
9+
10+
Includes Files or Functions into a Script.
11+
12+
---
13+
### Examples
14+
#### EXAMPLE 1
15+
```PowerShell
16+
{
17+
[Include("Invoke-PipeScript")]$null
18+
} | .>PipeScript
19+
```
20+
21+
#### EXAMPLE 2
22+
```PowerShell
23+
{
24+
[Include("Invoke-PipeScript")]
25+
param()
26+
} | .>PipeScript
27+
```
28+
29+
---
30+
### Parameters
31+
#### **FilePath**
32+
33+
The File Path to Include
34+
35+
36+
37+
|Type |Requried|Postion|PipelineInput|
38+
|--------------|--------|-------|-------------|
39+
|```[String]```|true |1 |false |
40+
---
41+
#### **AsByte**
42+
43+
If set, will include the content as a byte array
44+
45+
46+
47+
|Type |Requried|Postion|PipelineInput|
48+
|--------------|--------|-------|-------------|
49+
|```[Switch]```|false |named |false |
50+
---
51+
#### **VariableAst**
52+
53+
|Type |Requried|Postion|PipelineInput |
54+
|-----------------------------|--------|-------|--------------|
55+
|```[VariableExpressionAst]```|true |named |true (ByValue)|
56+
---
57+
### Syntax
58+
```PowerShell
59+
Transpilers/Include.psx.ps1 [-FilePath] <String> [-AsByte] -VariableAst <VariableExpressionAst> [<CommonParameters>]
60+
```
61+
---
62+
63+

0 commit comments

Comments
 (0)