Skip to content

Commit 8f2c4fb

Browse files
StartAutomatingStartAutomating
authored andcommitted
Include - Allowing Including URLs (Fixes #481)
1 parent 8d65b83 commit 8f2c4fb

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/Include.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ Includes Files or Functions into a Script.
4444
} | .>PipeScript
4545
```
4646

47+
#### EXAMPLE 4
48+
```PowerShell
49+
{
50+
[Include('https://pssvg.start-automating.com/Examples/PowerShellChevron.svg')]$PSChevron
51+
} | .>PipeScript
52+
```
53+
4754

4855

4956
---
@@ -59,9 +66,9 @@ The File Path to Include
5966

6067

6168

62-
|Type |Required|Position|PipelineInput|
63-
|----------|--------|--------|-------------|
64-
|`[String]`|true |1 |false |
69+
|Type |Required|Position|PipelineInput|Aliases |
70+
|----------|--------|--------|-------------|------------------------|
71+
|`[String]`|false |1 |false |FullName<br/>Uri<br/>Url|
6572

6673

6774

@@ -112,6 +119,12 @@ The exclusion pattern to use.
112119

113120
#### **VariableAst**
114121

122+
The variable that include will be applied to.
123+
If including files with wildcards, this will be the base path.
124+
Otherwise, this variable will be assigned to the included value.
125+
126+
127+
115128

116129

117130

@@ -123,6 +136,11 @@ The exclusion pattern to use.
123136

124137
#### **CommandAst**
125138

139+
The CommandAST.
140+
This is provided by the transpiler when include is used as a keyword.
141+
142+
143+
126144

127145

128146

@@ -139,8 +157,8 @@ The exclusion pattern to use.
139157

140158
### Syntax
141159
```PowerShell
142-
Include [-FilePath] <String> [-AsByte] [-Passthru] [-Exclude <String[]>] -VariableAst <VariableExpressionAst> [<CommonParameters>]
160+
Include [[-FilePath] <String>] [-AsByte] [-Passthru] [-Exclude <String[]>] -CommandAst <CommandAst> [<CommonParameters>]
143161
```
144162
```PowerShell
145-
Include [-FilePath] <String> [-AsByte] [-Passthru] [-Exclude <String[]>] -CommandAst <CommandAst> [<CommonParameters>]
163+
Include [-FilePath] <String> [-AsByte] [-Passthru] [-Exclude <String[]>] -VariableAst <VariableExpressionAst> [<CommonParameters>]
146164
```

0 commit comments

Comments
 (0)