Skip to content

Commit db1771d

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Get-WebSocket -PSTypeName ( Fixes #34 )
1 parent 8c1c4de commit db1771d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/Get-WebSocket.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,14 @@ The timeout for the WebSocket connection. If this is provided, after the timeou
231231
|------------|--------|--------|-------------|
232232
|`[TimeSpan]`|false |named |false |
233233

234+
#### **PSTypeName**
235+
If provided, will decorate the objects outputted from a websocket job.
236+
This will only decorate objects converted from JSON.
237+
238+
|Type |Required|Position|PipelineInput|Aliases |
239+
|------------|--------|--------|-------------|---------------------------------------|
240+
|`[String[]]`|false |named |false |PSTypeNames<br/>Decorate<br/>Decoration|
241+
234242
#### **Maximum**
235243
The maximum number of messages to receive before closing the WebSocket.
236244

@@ -266,5 +274,5 @@ RunspacePools allow you to limit the scope of the handler to a pool of runspaces
266274

267275
### Syntax
268276
```PowerShell
269-
Get-WebSocket [[-WebSocketUri] <Uri>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Watch] [-RawText] [-Binary] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-Maximum <Int64>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [<CommonParameters>]
277+
Get-WebSocket [[-WebSocketUri] <Uri>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Watch] [-RawText] [-Binary] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [<CommonParameters>]
270278
```

0 commit comments

Comments
 (0)