Skip to content

Commit 7ccaa7f

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Get-WebSocket -Timeout/-LifeSpan server support ( Fixes #85 )
1 parent e2f05ee commit 7ccaa7f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/Get-WebSocket.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,11 @@ A javascript import map. This allows you to import javascript modules.
217217
#### **QueryParameter**
218218
A collection of query parameters.
219219
These will be appended onto the `-SocketUrl`.
220+
Multiple values for a single parameter will be passed as multiple parameters.
220221

221-
|Type |Required|Position|PipelineInput |
222-
|---------------|--------|--------|---------------------|
223-
|`[IDictionary]`|false |named |true (ByPropertyName)|
222+
|Type |Required|Position|PipelineInput |Aliases |
223+
|---------------|--------|--------|---------------------|-------------------------|
224+
|`[IDictionary]`|false |named |true (ByPropertyName)|QueryParameters<br/>Query|
224225

225226
#### **Handler**
226227
A ScriptBlock that can handle the output of the WebSocket or the Http Request.
@@ -390,11 +391,12 @@ The values of the dictionary are what will happen when a match is found.
390391
|`[IDictionary]`|false |named |true (ByPropertyName)|WhereFor<br/>Wherefore|
391392

392393
#### **TimeOut**
393-
The timeout for the WebSocket connection. If this is provided, after the timeout elapsed, the WebSocket will be closed.
394+
The timeout for the WebSocket connection.
395+
If this is provided, after the timeout elapsed, the WebSocket will be closed.
394396

395-
|Type |Required|Position|PipelineInput|
396-
|------------|--------|--------|-------------|
397-
|`[TimeSpan]`|false |named |false |
397+
|Type |Required|Position|PipelineInput |Aliases |
398+
|------------|--------|--------|---------------------|--------|
399+
|`[TimeSpan]`|false |named |true (ByPropertyName)|Lifespan|
398400

399401
#### **PSTypeName**
400402
If provided, will decorate the objects outputted from a websocket job.

0 commit comments

Comments
 (0)