improve API docs #64
improve API docs #64
Conversation
motivation: better documentation, happier users changes: add more inforamtion on public APIs
|
|
||
| /// A processing closure for a Lambda that takes a `In` and returns a `Result<Out, Error>` via a `CompletionHandler` asynchronously. | ||
| /// An asynchronous Lambda Closure that takes a `In: Decodable` and returns a `Result<Out: Encodable, Error>` via a completion handler. | ||
| public typealias CodableLambdaClosure<In: Decodable, Out: Encodable> = (Lambda.Context, In, @escaping (Result<Out, Error>) -> Void) -> Void |
There was a problem hiding this comment.
Do we want to move the typealias up right before the matching Lambda.run function? For readability I prefer if typealiases to be defined as close to the usage as possible.
| /// | ||
| /// - note: This is a blocking operation that will run forever, as its lifecycle is managed by the AWS Lambda Runtime Engine. | ||
| public static func run(_ factory: @escaping LambdaHandlerFactory) { | ||
| public static func run(_ factory: @escaping ByteBufferLambdaHandlerFactory) { |
There was a problem hiding this comment.
I'm not sure if I like this renaming. Sure, the Handler that we want to see returned is a ByteBufferLambdaHandler and all other protocols inherit from it. But the new naming gives it IMHO an exclusive feel, especially since we don't have an EventLoopLambdaHandlerFactory or a LambdaHandlerFactory.
This is not a strong con, just wanted to point it the implication it gave me.
| /// `ByteBufferLambdaHandler` factory. | ||
| /// | ||
| /// A function that takes a `EventLoop` and returns an `EventLoopFuture` of a `ByteBufferLambdaHandler` | ||
| public typealias ByteBufferLambdaHandlerFactory = (EventLoop) -> EventLoopFuture<ByteBufferLambdaHandler> |
There was a problem hiding this comment.
As stated above: Do we maybe want to move this typealias up? Maybe even rename:
Lambda.HandlerFactory?
typos Co-Authored-By: Fabian Fett <[email protected]> Co-Authored-By: Yim Lee <[email protected]>
|
@fabianfett @yim-lee feedback addressed |
Co-Authored-By: Yim Lee <[email protected]>
motivation: better documentation, happier users
changes: add more inforamtion on public APIs