Skip to content

Commit 8287e17

Browse files
docs: Updates public function documentation
1 parent a66eead commit 8287e17

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

Sources/GraphQLTransportWS/Client.swift

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ public actor Client<InitPayload: Equatable & Codable> {
1717
///
1818
/// - Parameters:
1919
/// - messenger: The messenger to bind the client to.
20+
/// - onConnectionAck: The callback run on receipt of a `connection_ack` message
21+
/// - onNext: The callback run on receipt of a `next` message
22+
/// - onError: The callback run on receipt of an `error` message
23+
/// - onComplete: The callback run on receipt of a `complete` message
2024
public init(
2125
messenger: Messenger,
2226
onConnectionAck: @escaping (ConnectionAckResponse, Client) async throws -> Void = { _, _ in },

Sources/GraphQLTransportWS/Messenger.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// Protocol for an object that can send messages. This allows mocking in tests.
3+
/// Protocol for an object that can send messages.
44
public protocol Messenger: Sendable {
55
/// Send a message through this messenger
66
/// - Parameter message: The message to send

Sources/GraphQLTransportWS/Server.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ public actor Server<
3232
/// - messenger: The messenger to bind the server to.
3333
/// - onExecute: Callback run during `start` resolution for non-streaming queries. Typically this is `API.execute`.
3434
/// - onSubscribe: Callback run during `start` resolution for streaming queries. Typically this is `API.subscribe`.
35-
/// - onMessage: Optional callback run on every message event
3635
/// - onOperationComplete: Optional callback run when an operation completes
3736
/// - onOperationError: Optional callback run when an operation errors
3837
public init(

0 commit comments

Comments
 (0)