https://github.com/vert-x3/vertx-lang-kotlin

Vert.x for Kotlin
https://github.com/vert-x3/vertx-lang-kotlin

async coroutines kotlin non-blocking vertx

Last synced: 26 days ago
JSON representation

Vert.x for Kotlin

• Host: GitHub
• URL: https://github.com/vert-x3/vertx-lang-kotlin
• Owner: vert-x3
• License: apache-2.0
• Created: 2016-10-31T16:35:38.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T15:59:05.000Z (7 months ago)
• Last Synced: 2024-05-21T01:58:49.759Z (6 months ago)
• Topics: async, coroutines, kotlin, non-blocking, vertx
• Language: Kotlin
• Homepage:
• Size: 2.67 MB
• Stars: 286
• Watchers: 26
• Forks: 66
• Open Issues: 10
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

• vertx-awesome - Kotlin - <img src="vertx-favicon.svg" alt="(stack)" title="Vert.x Stack" height="16px"> - Kotlin support. (Language Support)

README

        
= Vert.x for Kotlin

image:https://github.com/vert-x3/vertx-lang-kotlin/actions/workflows/ci-5.x.yml/badge.svg["Build Status (5.x)",link="https://github.com/vert-x3/vertx-lang-kotlin/actions/workflows/ci-5.x.yml"]

image:https://github.com/vert-x3/vertx-lang-kotlin/actions/workflows/ci-4.x.yml/badge.svg["Build Status (4.x)",link="https://github.com/vert-x3/vertx-lang-kotlin/actions/workflows/ci-4.x.yml"]

image:https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat["GitHub license",link="http://www.apache.org/licenses/LICENSE-2.0"]

image:https://img.shields.io/badge/kotlin-1.7.21-blue.svg["Kotlin version badge",link="https://kotlinlang.org"]

image:https://img.shields.io/badge/kotlinx.coroutines-1.6.4-blue.svg["Coroutines version badge",link="https://github.com/Kotlin/kotlinx.coroutines#kotlinxcoroutines"]

This is the repository for http://kotlinlang.org[Kotlin] language support for http://vertx.io/docs[Vert.x].

The following modules are available in this project:

* `vertx-lang-kotlin` contains extension functions for the majority of Vert.x libraries.

* `vertx-lang-kotlin-coroutines` contains coroutines support for https://vertx.io/docs/vertx-lang-kotlin-coroutines/kotlin/[Vert.x].

== Contributing

=== Extending Vert.x for Kotlin

Kotlin's extensions are developed in this link:vertx-lang-kotlin/src/main/java/io/vertx/kotlin[directory].

For instance `vertx-core` extensions are in the `io.vertx.kotlin.core` package, etc...

Extensions needs to be tested and link:vertx-lang-kotlin/src/main/asciidoc/vertx-core/kotlin/index.adoc[documented].

=== Bumping Kotlin version

There are a couple of rules to follow before increasing the project versions:

* If changing one between `kotlin` and `kotlinx.coroutines` version, make sure that all transitive dependencies, like

`kotlin-stdlib`, still match between the two versions.

Kotlin evolves fast, so just change the project versions, test it, and shot a PR.