feat: Kotlin update and @Throws annotations - #32
Merged
Conversation
Add `@Throws` annotations to the `JecnaClient` and `CanteenClient` interfaces to establish explicit error contracts for Kotlin Multiplatform consumers. This provides typed error support for Swift.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@Throwsannotations on interface functions for native Swift code.This is required for the function to gracefully hand the exception in the native Swift code rather than panicing and crashing the whole app using the function.
The
RuntimeExceptionin the@Throwsis to catch any exceptions that ktor might throw. Afaik there is no single exception likeKtorExceptionthat we could reference all of the possible ktor exception, so I think this is the best way of doing so, while not forcing JVM users to handle every function with try catch, and we don't have to list out all of the possible Exceptions ktor might throw.Note: The
@Throwsisn't specifically required in this Kotlin version, that's for all of them, i just didn't feel like making PR just to update single version number. You can make this to be two commits rather than squash if you want it separate.