[!NOTE] Maintained continuation: This repository is a fork of Kotlinx Serialization TypeScript Generator (KxsTsGen), building on its original implementation while continuing development and releases under the io.github.esafak namespace.

kotlin-tsgen creates TypeScript interfaces from kotlinx.serialization classes, allowing for quick and easy communication via JSON with a Kotlin-first approach.

import kotlinx.serialization.*
import io.github.esafak.kotlintsgen.*

@Serializable
class MyClass(
  val aString: String,
  var anInt: Int,
  val aDouble: Double,
  val bool: Boolean,
  private val privateMember: String,
)

fun main() {
  val tsGenerator = KotlinTsGenerator()
  println(tsGenerator.generate(MyClass.serializer()))
}

Generated TypeScript interface:

export interface MyClass {
  aString: string;
  anInt: number;
  aDouble: number;
  bool: boolean;
  privateMember: string;
}

Only Kotlinx Serialization SerialDescriptors are used to generate TypeScript. They are flexible and comprehensive enough to allow for accurate TypeScript code, without any surprises.

See the docs for working examples.