Skip to content

Commit ab00d9d

Browse files
StartAutomatingStartAutomating
StartAutomating
authored and
StartAutomating
committed
feat: Get-WebSocket -SubProtocol ( Fixes #46 )
1 parent c5175af commit ab00d9d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/Get-WebSocket.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,13 @@ If set, will output the raw bytes that come out of the WebSocket.
234234
|----------|--------|--------|-------------|---------------------------------------|
235235
|`[Switch]`|false |named |false |RawByte<br/>RawBytes<br/>Bytes<br/>Byte|
236236

237+
#### **SubProtocol**
238+
The subprotocol used by the websocket. If not provided, this will default to `json`.
239+
240+
|Type |Required|Position|PipelineInput|
241+
|----------|--------|--------|-------------|
242+
|`[String]`|false |named |false |
243+
237244
#### **WatchFor**
238245
If set, will watch the output of a WebSocket job for one or more conditions.
239246
The conditions are the keys of the dictionary, and can be a regex, a string, or a scriptblock.
@@ -293,5 +300,5 @@ RunspacePools allow you to limit the scope of the handler to a pool of runspaces
293300

294301
### Syntax
295302
```PowerShell
296-
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>]
303+
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] [-SubProtocol <String>] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [<CommonParameters>]
297304
```

0 commit comments

Comments
 (0)