Need help with kotlinx.coroutines?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Kotlin
8.5K Stars 1.2K Forks Apache License 2.0 2.2K Commits 274 Opened issues

Description

Library support for Kotlin coroutines

Services available

!
?

Need anything else?

Contributors list

No Data

kotlinx.coroutines

official JetBrains project GitHub license Download Kotlin Slack channel

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

Modules

Documentation

Using in your projects

The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.

Maven

Add dependencies (you can also add other modules that you need):

    org.jetbrains.kotlinx
    kotlinx-coroutines-core
    1.4.2

And make sure that you use the latest Kotlin version:

    1.4.0

Gradle

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2'
}

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()
}

Gradle Kotlin DSL

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2")
}

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.

Multiplatform

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:
groovy
commonMain {
    dependencies {
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2")
    }
}

Android

Add

kotlinx-coroutines-android
module as dependency when using

kotlinx.coroutines
on Android:
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.2'

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

R8 and ProGuard rules are bundled into the

kotlinx-coroutines-android
module. For more details see "Optimization" section for Android.

Avoiding including the debug infrastructure in the resulting APK

The

kotlinx-coroutines-core
artifact contains a resource file that is not required for the coroutines to operate normally and is only used by the debugger. To exclude it at no loss of functionality, add the following snippet to the
android
block in your gradle file for the application subproject:
groovy
packagingOptions {
  exclude "DebugProbesKt.bin"
}

JS

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.

Native

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
.

Building and Contributing

See Contributing Guidelines.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.