Skip to main content

Enums

Simple enum​

@Serializable
enum class SomeType {
  Alpha,
  Beta,
  Gamma
}

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

You can get the full code here.

export enum SomeType {
  Alpha = "Alpha",
  Beta = "Beta",
  Gamma = "Gamma",
}

Enum with properties​

Because enums are static, fields aren't converted.

@Serializable
enum class SomeType2(val coolName: String) {
  Alpha("alpha") {
    val extra: Long = 123L
  },
  Beta("be_beta"),
  Gamma("gamma 3 3 3")
}

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

You can get the full code here.

export enum SomeType2 {
  Alpha = "Alpha",
  Beta = "Beta",
  Gamma = "Gamma",
}

Enum with serial names​

@SerialName controls the serialized enum member value and the generated TypeScript member name. Names used as TypeScript identifiers must be valid; invalid names fail generation with a clear error.

@Serializable
enum class WireType {
  @SerialName("discussion")
  DISCUSSION,
  @SerialName("chat_room")
  CHAT_ROOM,
}

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

You can get the full code here.

export enum WireType {
  discussion = "discussion",
  chat_room = "chat_room",
}