Skip to content

Commit 841bcd7

Browse files
authored
Update Functions Swift public API docs (#9145)
1 parent 56d2f1e commit 841bcd7

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

FirebaseFunctionsSwift/Sources/Codable/Callable+Codable.swift

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ public extension Functions {
2020
/// Creates a reference to the Callable HTTPS trigger with the given name, the type of an `Encodable`
2121
/// request and the type of a `Decodable` response.
2222
/// - Parameter name: The name of the Callable HTTPS trigger
23-
/// - Parameter requestType: The type of the `Encodable` entity to use for requests to this `Callable`
24-
/// - Parameter responseType: The type of the `Decodable` entity to use for responses from this `Callable`
23+
/// - Parameter requestAs: The type of the `Encodable` entity to use for requests to this `Callable`
24+
/// - Parameter responseAs: The type of the `Decodable` entity to use for responses from this `Callable`
25+
/// - Parameter encoder: The encoder instance to use to run the encoding.
26+
/// - Parameter decoder: The decoder instance to use to run the decoding.
2527
func httpsCallable<Request: Encodable,
2628
Response: Decodable>(_ name: String,
27-
requestAs requestType: Request.Type = Request.self,
28-
responseAs responseType: Response.Type = Response.self,
29+
requestAs: Request.Type = Request.self,
30+
responseAs: Response.Type = Response.self,
2931
encoder: FirebaseDataEncoder = FirebaseDataEncoder(),
3032
decoder: FirebaseDataDecoder = FirebaseDataDecoder())
3133
-> Callable<Request, Response> {
@@ -139,9 +141,10 @@ public struct Callable<Request: Encodable, Response: Decodable> {
139141
/// resumes with a new FCM Token the next time you call this method.
140142
///
141143
/// - Parameter data: The `Request` representing the data to pass to the trigger.
144+
/// - Parameter encoder: The encoder instance to use to run the encoding.
145+
/// - Parameter decoder: The decoder instance to use to run the decoding.
142146
///
143-
/// - Throws: An error if any value throws an error during encoding.
144-
/// - Throws: An error if any value throws an error during decoding.
147+
/// - Throws: An error if any value throws an error during encoding or decoding.
145148
/// - Throws: An error if the callable fails to complete
146149
///
147150
/// - Returns: The decoded `Response` value

0 commit comments

Comments
 (0)