Skip to content

Fix ktdocs for select and awaitAll #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slinkydeveloper merged 1 commit into from
Apr 14, 2025
Merged

Fix ktdocs for select and awaitAll #494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/api.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,24 +530,19 @@ sealed interface DurableFuture<T> {
* Like [kotlinx.coroutines.awaitAll], but for [DurableFuture].
*
* ```
* val ctx = restateContext()
* val a1 = ctx.callAsync(GreeterGrpcKt.greetMethod, greetingRequest { name = "Francesco" })
* val a2 = ctx.callAsync(GreeterGrpcKt.greetMethod, greetingRequest { name = "Till" })
* val a1 = ctx.awakeable<String>()
* val a2 = ctx.awakeable<String>()
*
* val result = listOf(a1, a2)
* .awaitAll()
* .joinToString(separator = "-", transform = GreetingResponse::getMessage)
* .joinToString(separator = "-")
* ```
*/
suspend fun <T> Collection<DurableFuture<T>>.awaitAll(): List<T> {
return awaitAll(*toTypedArray())
}

/**
* Like [kotlinx.coroutines.awaitAll], but for [DurableFuture].
*
* ```
*/
/** @see Collection.awaitAll */
suspend fun <T> awaitAll(vararg durableFutures: DurableFuture<T>): List<T> {
if (durableFutures.isEmpty()) {
return emptyList()
Expand All @@ -563,9 +558,9 @@ suspend fun <T> awaitAll(vararg durableFutures: DurableFuture<T>): List<T> {
* Like [kotlinx.coroutines.selects.select], but for [DurableFuture]
*
* ```
* val ctx = restateContext()
* val callFuture = ctx.callAsync(GreeterGrpcKt.greetMethod, greetingRequest { name = "Francesco" })
* val callFuture = ctx.awakeable()
* val timeout = ctx.timer(10.seconds)
*
* val result = select {
* callFuture.onAwait { it.message }
* timeout.onAwait { throw TimeoutException() }
Expand Down