commit | 0cab30bc79575dfe7702766a99a7b9753218bb13 | [log] [tgz] |
---|---|---|
author | Roman Elizarov <elizarov@gmail.com> | Tue Sep 08 19:42:36 2020 +0300 |
committer | GitHub <noreply@github.com> | Tue Sep 08 19:42:36 2020 +0300 |
tree | 9611c8260cea37d636913aec7d6526fd7d90ff67 | |
parent | 1ec50feb7f6601f8df08d2e21dec4cf324f5d6fd [diff] |
Contributing Guidelines (#2232) Also moving there building instructions from README.md as only contributors shall care about them.
Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.4.0
release.
suspend fun main() = coroutineScope { launch { delay(1000) println("Kotlin Coroutines World!") } println("Hello") }
Play with coroutines online here
Promise
via Promise.await and promise builder;Window
via Window.asCoroutineDispatcher, etc.The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.
Add dependencies (you can also add other modules that you need):
<dependency> <groupId>org.jetbrains.kotlinx</groupId> <artifactId>kotlinx-coroutines-core</artifactId> <version>1.3.9</version> </dependency>
And make sure that you use the latest Kotlin version:
<properties> <kotlin.version>1.4.0</kotlin.version> </properties>
Add dependencies (you can also add other modules that you need):
dependencies { implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9' }
And make sure that you use the latest Kotlin version:
buildscript { ext.kotlin_version = '1.4.0' }
Make sure that you have either jcenter()
or mavenCentral()
in the list of repositories:
repository { jcenter() }
Add dependencies (you can also add other modules that you need):
dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9") }
And make sure that you use the latest Kotlin version:
plugins { kotlin("jvm") version "1.4.0" }
Make sure that you have either jcenter()
or mavenCentral()
in the list of repositories.
Core modules of kotlinx.coroutines
are also available for Kotlin/JS and Kotlin/Native. In common code that should get compiled for different platforms, you can add dependency to kotlinx-coroutines-core
right to the commonMain
source set:
commonMain { dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9") } }
Add kotlinx-coroutines-android
module as dependency when using kotlinx.coroutines
on Android:
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
This gives you access to Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of crashed coroutine with unhandled exception this exception is logged before crashing Android application, similarly to the way uncaught exceptions in threads are handled by Android runtime.
R8 and ProGuard rules are bundled into the kotlinx-coroutines-android
module. For more details see "Optimization" section for Android.
Kotlin/JS version of kotlinx.coroutines
is published as kotlinx-coroutines-core-js
(follow the link to get the dependency declaration snippet).
You can also use kotlinx-coroutines-core
package via NPM.
Kotlin/Native version of kotlinx.coroutines
is published as kotlinx-coroutines-core-native
(follow the link to get the dependency declaration snippet).
Only single-threaded code (JS-style) on Kotlin/Native is currently supported. Kotlin/Native supports only Gradle version 4.10 and you need to enable Gradle metadata in your settings.gradle
file:
enableFeaturePreview('GRADLE_METADATA')
Since Kotlin/Native does not generally provide binary compatibility between versions, you should use the same version of Kotlin/Native compiler as was used to build kotlinx.coroutines
.