Skip to content

Commit 234d7ff

Browse files
StartAutomatingStartAutomating
authored andcommitted
Join-PipeScript: Improving Unnamed end block behavior (Fixes #363)
1 parent 3415dcf commit 234d7ff

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

docs/TOML.Template.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
TOML.Template
22
-------------
3+
4+
5+
6+
37
### Synopsis
48
TOML Template Transpiler.
59

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

917
Allows PipeScript to generate TOML.
@@ -12,7 +20,11 @@ Because TOML does not support comment blocks, PipeScript can be written inline i
1220

1321
PipeScript can be included in a TOML string that starts and ends with ```{}```, for example ```"""{}"""```
1422

23+
24+
1525
---
26+
27+
1628
### Examples
1729
#### EXAMPLE 1
1830
```PowerShell
@@ -25,82 +37,82 @@ RandomNumber = """{Get-Random}"""
2537
}
2638
```
2739
.> .\RandomExample.ps1.toml
40+
41+
2842
---
43+
44+
2945
### Parameters
3046
#### **CommandInfo**
3147

3248
The command information. This will include the path to the file.
3349

3450

3551

36-
> **Type**: ```[CommandInfo]```
3752

38-
> **Required**: true
3953

40-
> **Position**: named
4154

42-
> **PipelineInput**:true (ByValue)
55+
|Type |Required|Position|PipelineInput |
56+
|---------------|--------|--------|--------------|
57+
|`[CommandInfo]`|true |named |true (ByValue)|
4358

4459

4560

46-
---
4761
#### **AsTemplateObject**
4862

4963
If set, will return the information required to dynamically apply this template to any text.
5064

5165

5266

53-
> **Type**: ```[Switch]```
5467

55-
> **Required**: true
5668

57-
> **Position**: named
5869

59-
> **PipelineInput**:false
70+
|Type |Required|Position|PipelineInput|
71+
|----------|--------|--------|-------------|
72+
|`[Switch]`|true |named |false |
6073

6174

6275

63-
---
6476
#### **Parameter**
6577

6678
A dictionary of parameters.
6779

6880

6981

70-
> **Type**: ```[IDictionary]```
7182

72-
> **Required**: false
7383

74-
> **Position**: named
7584

76-
> **PipelineInput**:false
85+
|Type |Required|Position|PipelineInput|
86+
|---------------|--------|--------|-------------|
87+
|`[IDictionary]`|false |named |false |
7788

7889

7990

80-
---
8191
#### **ArgumentList**
8292

8393
A list of arguments.
8494

8595

8696

87-
> **Type**: ```[PSObject[]]```
8897

89-
> **Required**: false
9098

91-
> **Position**: named
9299

93-
> **PipelineInput**:false
100+
|Type |Required|Position|PipelineInput|
101+
|--------------|--------|--------|-------------|
102+
|`[PSObject[]]`|false |named |false |
103+
104+
94105

95106

96107

97108
---
109+
110+
98111
### Syntax
99112
```PowerShell
100113
TOML.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
101114
```
102115
```PowerShell
103116
TOML.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
104117
```
105-
---
106118

0 commit comments

Comments
 (0)