Skip to content

Commit b62a4d0

Browse files
author
James Brundage
committed
docs: Get-WebSocket docs ( Fixes #82 )
Documenting WebSocketclient
2 parents 922f57d + 803b11e commit b62a4d0

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/Get-WebSocket.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -320,11 +320,15 @@ This will run after the socket is connected but before any messages are received
320320
|------------|--------|--------|-------------|--------------------------|
321321
|`[PSObject]`|false |named |false |Authorize<br/>HelloMessage|
322322

323-
#### **Reply**
323+
#### **Handshake**
324+
If provided, will shake hands after the first websocket message is received.
325+
This parameter can be either a ScriptBlock or any other object.
326+
If it is a ScriptBlock, it will be run with the output of the WebSocket passed as the first argument.
327+
This will run after the socket is connected and the first message is received.
324328

325-
|Type |Required|Position|PipelineInput|Aliases |
326-
|------------|--------|--------|-------------|----------------------|
327-
|`[PSObject]`|false |named |false |Identify<br/>AutoReply|
329+
|Type |Required|Position|PipelineInput|Aliases |
330+
|------------|--------|--------|-------------|--------|
331+
|`[PSObject]`|false |named |false |Identify|
328332

329333
#### **Watch**
330334
If set, will watch the output of the WebSocket job, outputting results continuously instead of outputting a websocket job.
@@ -456,8 +460,8 @@ RunspacePools allow you to limit the scope of the handler to a pool of runspaces
456460

457461
### Syntax
458462
```PowerShell
459-
Get-WebSocket [[-SocketUrl] <Uri>] [-QueryParameter <IDictionary>] [-ForwardEvent] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Authenticate <PSObject>] [-Reply <PSObject>] [-Watch] [-RawText] [-Binary] [-Force] [-SubProtocol <String>] [-Filter <PSObject[]>] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
463+
Get-WebSocket [[-SocketUrl] <Uri>] [-QueryParameter <IDictionary>] [-ForwardEvent] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Authenticate <PSObject>] [-Handshake <PSObject>] [-Watch] [-RawText] [-Binary] [-Force] [-SubProtocol <String>] [-Filter <PSObject[]>] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
460464
```
461465
```PowerShell
462-
Get-WebSocket -RootUrl <String[]> [-Route <IDictionary>] [-HTML <String>] [-PaletteName <String>] [-GoogleFont <String>] [-CodeFont <String>] [-JavaScript <String[]>] [-ImportMap <IDictionary>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-Reply <PSObject>] [-Force] [-TimeOut <TimeSpan>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
466+
Get-WebSocket -RootUrl <String[]> [-Route <IDictionary>] [-HTML <String>] [-PaletteName <String>] [-GoogleFont <String>] [-CodeFont <String>] [-JavaScript <String[]>] [-ImportMap <IDictionary>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-Force] [-TimeOut <TimeSpan>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
463467
```

0 commit comments

Comments
 (0)