Getting Started

kxs-ts-gen is published to Maven Central.

Be sure to apply the Kotlinx Serialization plugin.

Adding a dependency

Gradle Kotlin DSL

plugins {
  kotlin("jvm") version "1.8.0"
  kotlin("plugin.serialization") version "1.8.0"
}

dependencies {
  implementation("dev.adamko.kxstsgen:kxs-ts-gen-core:0.2.1")
}

Gradle Groovy DSL

plugins {
  id "org.jetbrains.kotlin.jvm" version "1.8.0"
  id "org.jetbrains.kotlin.plugin.serialization" version "1.8.0"
}

dependencies {
  implementation("dev.adamko.kxstsgen:kxs-ts-gen-core:0.2.1")
}

Maven

info

Maven must postfix the module name with the target variant, for example: -jvm

<dependency>
  <groupId>dev.adamko.kxstsgen</groupId>
  <artifactId>kxs-ts-gen-core-jvm</artifactId>
  <version>0.2.1</version>
</dependency>

Usage

See Docs for examples of how to generate TypeScript interfaces from Kotlin classes.