Skip to content

Commit 244f27e

Browse files
author
James Brundage
committed
Merge branch 'PipeScript-Phases' of https://github.com/StartAutomating/PipeScript into PipeScript-Phases
2 parents 7b5c81a + ed5f76c commit 244f27e

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

docs/Inherit.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ Invoke-PipeScript {
8383
### Parameters
8484
#### **Command**
8585

86+
The command that will be inherited.
87+
88+
89+
8690

8791

8892

@@ -264,6 +268,78 @@ Excluded parameters with default values will declare the default value at the be
264268

265269

266270

271+
#### **ArgumentListParameterName**
272+
273+
The ArgumentList parameter name
274+
When inheriting an application, a parameter is created to accept any remaining arguments.
275+
This is the name of that parameter (by default, 'ArgumentList')
276+
This parameter is ignored when inheriting from anything other than an application.
277+
278+
279+
280+
281+
282+
283+
|Type |Required|Position|PipelineInput|Aliases |
284+
|----------|--------|--------|-------------|---------------------|
285+
|`[String]`|false |named |false |ArgumentListParameter|
286+
287+
288+
289+
#### **ArgumentListParameterAlias**
290+
291+
The ArgumentList parameter aliases
292+
When inheriting an application, a parameter is created to accept any remaining arguments.
293+
These are the aliases for that parameter (by default, 'Arguments' and 'Args')
294+
This parameter is ignored when inheriting from anything other than an application.
295+
296+
297+
298+
299+
300+
301+
|Type |Required|Position|PipelineInput|Aliases |
302+
|------------|--------|--------|-------------|-----------------------------------------------------|
303+
|`[String[]]`|false |named |false |ArgumentListParameters<br/>ArgumentListParameterNames|
304+
305+
306+
307+
#### **ArgumentListParameterType**
308+
309+
The ArgumentList parameter type
310+
When inheriting an application, a parameter is created to accept any remaining arguments.
311+
This is the type of that parameter (by default, '[string[]]')
312+
This parameter is ignored when inheriting from anything other than an application.
313+
314+
315+
316+
317+
318+
319+
|Type |Required|Position|PipelineInput|
320+
|--------|--------|--------|-------------|
321+
|`[Type]`|false |named |false |
322+
323+
324+
325+
#### **ArgumentListParameterHelp**
326+
327+
The help for the argument list parameter.
328+
When inheriting an application, a parameter is created to accept any remaining arguments.
329+
This is the help of that parameter (by default, 'Arguments to $($InhertedApplication.Name)')
330+
This parameter is ignored when inheriting from anything other than an application.
331+
332+
333+
334+
335+
336+
337+
|Type |Required|Position|PipelineInput|Aliases |
338+
|----------|--------|--------|-------------|--------------------------------|
339+
|`[String]`|false |named |false |ArgumentListParameterDescription|
340+
341+
342+
267343
#### **ScriptBlock**
268344

269345

@@ -282,5 +358,5 @@ Excluded parameters with default values will declare the default value at the be
282358

283359
### Syntax
284360
```PowerShell
285-
Inherit [-Command] <String> [-Abstract] [-Override] [-Dynamic] [-Proxy] [-CommandType <String[]>] [-ExcludeBlockType <String[]>] [-IncludeBlockType <String[]>] [-IncludeParameter <String[]>] [-ExcludeParameter <String[]>] [-ScriptBlock <ScriptBlock>] [<CommonParameters>]
361+
Inherit [-Command] <String> [-Abstract] [-Override] [-Dynamic] [-Proxy] [-CommandType <String[]>] [-ExcludeBlockType <String[]>] [-IncludeBlockType <String[]>] [-IncludeParameter <String[]>] [-ExcludeParameter <String[]>] [-ArgumentListParameterName <String>] [-ArgumentListParameterAlias <String[]>] [-ArgumentListParameterType <Type>] [-ArgumentListParameterHelp <String>] [-ScriptBlock <ScriptBlock>] [<CommonParameters>]
286362
```

0 commit comments

Comments
 (0)