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