Skip to content

Commit 4098f07

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding and Updating READMEs
1 parent 395be3f commit 4098f07

File tree

1 file changed

+66
-6
lines changed

1 file changed

+66
-6
lines changed

Commands/Aspects/README.md

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ When a file is built, any aspects will be consolidated and embedded inline.
99

1010
|Name |Synopsis |
1111
|-----------------------------------------------------------------------|------------------------------------------------------------------------------|
12-
|[Aspect.DynamicParameters](/docs/Aspect.DynamicParameters.md) |[](/docs/Aspect.DynamicParameters.md) |
13-
|[Aspect.ModuleCommandTypes](/docs/Aspect.ModuleCommandTypes.md) |[](/docs/Aspect.ModuleCommandTypes.md) |
14-
|[Aspect.ModuleCommandType](/docs/Aspect.ModuleCommandType.md) |[](/docs/Aspect.ModuleCommandType.md) |
15-
|[Aspect.ModuleExtensionTypes](/docs/Aspect.ModuleExtensionTypes.md) |[](/docs/Aspect.ModuleExtensionTypes.md) |
16-
|[Aspect.ModuleCommandPattern](/docs/Aspect.ModuleCommandPattern.md) |[](/docs/Aspect.ModuleCommandPattern.md) |
17-
|[Aspect.ModuleExtendedCommand](/docs/Aspect.ModuleExtendedCommand.md) |[](/docs/Aspect.ModuleExtendedCommand.md) |
12+
|[Aspect.DynamicParameters](/docs/Aspect.DynamicParameters.md) |[Dynamic Parameter Aspect](/docs/Aspect.DynamicParameters.md) |
13+
|[Aspect.ModuleCommandTypes](/docs/Aspect.ModuleCommandTypes.md) |[Outputs a module's extension types](/docs/Aspect.ModuleCommandTypes.md) |
14+
|[Aspect.ModuleCommandType](/docs/Aspect.ModuleCommandType.md) |[Outputs a module's extension types](/docs/Aspect.ModuleCommandType.md) |
15+
|[Aspect.ModuleExtensionTypes](/docs/Aspect.ModuleExtensionTypes.md) |[Outputs a module's extension types](/docs/Aspect.ModuleExtensionTypes.md) |
16+
|[Aspect.ModuleCommandPattern](/docs/Aspect.ModuleCommandPattern.md) |[Outputs a module's extension pattern](/docs/Aspect.ModuleCommandPattern.md) |
17+
|[Aspect.ModuleExtendedCommand](/docs/Aspect.ModuleExtendedCommand.md) |[Returns a module's extended commands](/docs/Aspect.ModuleExtendedCommand.md) |
1818
|[Aspect.DynamicParameter](/docs/Aspect.DynamicParameter.md) |[Dynamic Parameter Aspect](/docs/Aspect.DynamicParameter.md) |
1919
|[Aspect.ModuleExtensionType](/docs/Aspect.ModuleExtensionType.md) |[Outputs a module's extension types](/docs/Aspect.ModuleExtensionType.md) |
2020
|[Aspect.ModuleExtensionPattern](/docs/Aspect.ModuleExtensionPattern.md)|[Outputs a module's extension pattern](/docs/Aspect.ModuleExtensionPattern.md)|
@@ -27,6 +27,66 @@ When a file is built, any aspects will be consolidated and embedded inline.
2727

2828
All of the current aspect examples are listed below:
2929

30+
## Aspect.DynamicParameters -> Aspect.DynamicParameter Example 1
31+
32+
33+
~~~PowerShell
34+
Get-Command Get-Command |
35+
Aspect.DynamicParameter
36+
~~~
37+
38+
## Aspect.DynamicParameters -> Aspect.DynamicParameter Example 2
39+
40+
41+
~~~PowerShell
42+
Get-Command Get-Process |
43+
Aspect.DynamicParameter -IncludeParameter Name # Select -Expand Keys | Should -Be Name
44+
~~~
45+
46+
## Aspect.ModuleCommandTypes -> Aspect.ModuleExtensionType Example 1
47+
48+
49+
~~~PowerShell
50+
# Outputs a PSObject with information about extension command types.
51+
52+
# The two primary pieces of information are the `.Name` and `.Pattern`.
53+
Aspect.ModuleExtensionType -Module PipeScript # Should -BeOfType ([PSObject])
54+
~~~
55+
56+
## Aspect.ModuleCommandType -> Aspect.ModuleExtensionType Example 1
57+
58+
59+
~~~PowerShell
60+
# Outputs a PSObject with information about extension command types.
61+
62+
# The two primary pieces of information are the `.Name` and `.Pattern`.
63+
Aspect.ModuleExtensionType -Module PipeScript # Should -BeOfType ([PSObject])
64+
~~~
65+
66+
## Aspect.ModuleExtensionTypes -> Aspect.ModuleExtensionType Example 1
67+
68+
69+
~~~PowerShell
70+
# Outputs a PSObject with information about extension command types.
71+
72+
# The two primary pieces of information are the `.Name` and `.Pattern`.
73+
Aspect.ModuleExtensionType -Module PipeScript # Should -BeOfType ([PSObject])
74+
~~~
75+
76+
## Aspect.ModuleCommandPattern -> Aspect.ModuleExtensionPattern Example 1
77+
78+
79+
~~~PowerShell
80+
Aspect.ModuleCommandPattern -Module PipeScript # Should -BeOfType ([Regex])
81+
~~~
82+
83+
## Aspect.ModuleExtendedCommand -> Aspect.ModuleExtensionCommand Example 1
84+
85+
86+
~~~PowerShell
87+
Aspect.ModuleExtensionCommand -Module PipeScript # Should -BeOfType ([Management.Automation.CommandInfo])
88+
~~~
89+
3090
## Example 1
3191

3292

0 commit comments

Comments
 (0)