Skip to content

Commit 3cad8eb

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Get-WebSocket -Maximum ( Fixes #22 )
1 parent b1b6f74 commit 3cad8eb

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
@@ -149,6 +149,13 @@ The timeout for the WebSocket connection. If this is provided, after the timeou
149149
|------------|--------|--------|-------------|
150150
|`[TimeSpan]`|false |named |false |
151151

152+
#### **Maximum**
153+
The maximum number of messages to receive before closing the WebSocket.
154+
155+
|Type |Required|Position|PipelineInput|
156+
|---------|--------|--------|-------------|
157+
|`[Int64]`|false |named |false |
158+
152159
#### **ConnectionTimeout**
153160
The maximum time to wait for a connection to be established.
154161
By default, this is 7 seconds.
@@ -177,5 +184,5 @@ RunspacePools allow you to limit the scope of the handler to a pool of runspaces
177184

178185
### Syntax
179186
```PowerShell
180-
Get-WebSocket [[-WebSocketUri] <Uri>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Watch] [-TimeOut <TimeSpan>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [<CommonParameters>]
187+
Get-WebSocket [[-WebSocketUri] <Uri>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Watch] [-TimeOut <TimeSpan>] [-Maximum <Int64>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [<CommonParameters>]
181188
```

0 commit comments

Comments
 (0)