Skip to content

Commit 61ec825

Browse files
regenerate documentation
1 parent c06949e commit 61ec825

4 files changed

Lines changed: 36 additions & 1 deletion

File tree

docs/source/api/ApolloWebSocket/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Protocols
22

33
- [ApolloWebSocketClient](protocols/ApolloWebSocketClient/)
4+
- [SOCKSProxyable](protocols/SOCKSProxyable/)
45
- [WebSocketTransportDelegate](protocols/WebSocketTransportDelegate/)
56

67
## Structs

docs/source/api/ApolloWebSocket/classes/ApolloWebSocket.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,18 @@
33
# `ApolloWebSocket`
44

55
```swift
6-
public class ApolloWebSocket: WebSocket, ApolloWebSocketClient
6+
public class ApolloWebSocket: WebSocket, ApolloWebSocketClient, SOCKSProxyable
77
```
88

99
> Included implementation of an `ApolloWebSocketClient`, based on `Starscream`'s `WebSocket`.
1010

11+
## Properties
12+
### `enableSOCKSProxy`
13+
14+
```swift
15+
public var enableSOCKSProxy: Bool
16+
```
17+
1118
## Methods
1219
### `init(request:protocols:)`
1320

docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ public var clientVersion: String
3131

3232
> NOTE: Setting this won't override immediately if the socket is still connected, only on reconnection.
3333

34+
### `enableSOCKSProxy`
35+
36+
```swift
37+
public var enableSOCKSProxy: Bool
38+
```
39+
40+
> Determines whether a SOCKS proxy is enabled on the underlying request.
41+
> Mostly useful for debugging with tools like Charles Proxy.
42+
> Note: Will return `false` from the getter and no-op the setter for implementations that do not conform to `SOCKSProxyable`.
43+
3444
## Methods
3545
### `init(request:clientName:clientVersion:sendOperationIdentifiers:reconnect:reconnectionInterval:allowSendingDuplicates:connectingPayload:requestCreator:)`
3646

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
**PROTOCOL**
2+
3+
# `SOCKSProxyable`
4+
5+
```swift
6+
public protocol SOCKSProxyable
7+
```
8+
9+
## Properties
10+
### `enableSOCKSProxy`
11+
12+
```swift
13+
var enableSOCKSProxy: Bool
14+
```
15+
16+
> Determines whether a SOCKS proxy is enabled on the underlying request.
17+
> Mostly useful for debugging with tools like Charles Proxy.

0 commit comments

Comments
 (0)