1
1
TOML.Template
2
2
-------------
3
+
4
+
5
+
6
+
3
7
### Synopsis
4
8
TOML Template Transpiler.
5
9
10
+
11
+
6
12
---
13
+
14
+
7
15
### Description
8
16
9
17
Allows PipeScript to generate TOML.
@@ -12,7 +20,11 @@ Because TOML does not support comment blocks, PipeScript can be written inline i
12
20
13
21
PipeScript can be included in a TOML string that starts and ends with ``` {} ``` , for example ``` """{}""" ```
14
22
23
+
24
+
15
25
---
26
+
27
+
16
28
### Examples
17
29
#### EXAMPLE 1
18
30
``` PowerShell
@@ -25,82 +37,82 @@ RandomNumber = """{Get-Random}"""
25
37
}
26
38
```
27
39
.> .\RandomExample.ps1.toml
40
+
41
+
28
42
---
43
+
44
+
29
45
### Parameters
30
46
#### ** CommandInfo**
31
47
32
48
The command information. This will include the path to the file.
33
49
34
50
35
51
36
- > ** Type** : ``` [CommandInfo] ```
37
52
38
- > ** Required** : true
39
53
40
- > ** Position** : named
41
54
42
- > ** PipelineInput** : true (ByValue)
55
+ | Type | Required| Position| PipelineInput |
56
+ | ---------------| --------| --------| --------------|
57
+ | ` [CommandInfo] ` | true | named | true (ByValue)|
43
58
44
59
45
60
46
- ---
47
61
#### ** AsTemplateObject**
48
62
49
63
If set, will return the information required to dynamically apply this template to any text.
50
64
51
65
52
66
53
- > ** Type** : ``` [Switch] ```
54
67
55
- > ** Required** : true
56
68
57
- > ** Position** : named
58
69
59
- > ** PipelineInput** : false
70
+ | Type | Required| Position| PipelineInput|
71
+ | ----------| --------| --------| -------------|
72
+ | ` [Switch] ` | true | named | false |
60
73
61
74
62
75
63
- ---
64
76
#### ** Parameter**
65
77
66
78
A dictionary of parameters.
67
79
68
80
69
81
70
- > ** Type** : ``` [IDictionary] ```
71
82
72
- > ** Required** : false
73
83
74
- > ** Position** : named
75
84
76
- > ** PipelineInput** : false
85
+ | Type | Required| Position| PipelineInput|
86
+ | ---------------| --------| --------| -------------|
87
+ | ` [IDictionary] ` | false | named | false |
77
88
78
89
79
90
80
- ---
81
91
#### ** ArgumentList**
82
92
83
93
A list of arguments.
84
94
85
95
86
96
87
- > ** Type** : ``` [PSObject[]] ```
88
97
89
- > ** Required** : false
90
98
91
- > ** Position** : named
92
99
93
- > ** PipelineInput** : false
100
+ | Type | Required| Position| PipelineInput|
101
+ | --------------| --------| --------| -------------|
102
+ | ` [PSObject[]] ` | false | named | false |
103
+
104
+
94
105
95
106
96
107
97
108
---
109
+
110
+
98
111
### Syntax
99
112
``` PowerShell
100
113
TOML.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
101
114
```
102
115
``` PowerShell
103
116
TOML.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
104
117
```
105
- ---
106
118
0 commit comments