README.md

Inngest Kotlin SDK

Inngest SDK for Kotlin with Java interoperability.

Defining a function

Kotlin

class TranscodeVideo : InngestFunction() {
  override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
    builder
      .id("process-video")
      .name("Process video upload")
      .triggerEvent("media/video.uploaded")
      .retries(2)
      .concurrency(10)

  override fun execute(
    ctx: FunctionContext,
    step: Step,
  ): HashMap<String, Any> {
    val transcription =
      step.run("transcribe-video") {
        // Download video, run through transcription model, return output
        "Hi there, My name is Jamie..." // dummy example content
      }

    val summary =
      step.run("summarize") {
        // Send t
        "Hi there, My name is Jamie..." // dummy example content
      }

    step.run("save-results") {
      // Save summary, to your database
      // database.save(event.data["videoId"], transcription, summary)
    }

    return hashMapOf("restored" to false)
  }
}

Java (Coming soon)

Creating functions

Define your function's configuration using the config method and the InngestFunctionConfigBuilder class. The config method must be overridden and an id is required. All options should are discoverable via the builder class passed as the only argument to the config method.

Kotlin

import java.time.Duration

class TranscodeVideo : InngestFunction() {
  override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
    builder
      .id("process-video")
      .name("Process video upload")
      .triggerEvent("media/video.uploaded")
      .retries(2)
      .batchEvents(50, Duration.ofSeconds(30))
      .concurrency(10)
}

Sending events (triggering functions)

Kotlin

import java.time.Duration

class TranscodeVideo : InngestFunction() {
  override fun config(builder: InngestFunctionConfigBuilder): InngestFunctionConfigBuilder =
    builder
      .id("process-video")
      .name("Process video upload")
      .triggerEvent("media/video.uploaded")
      .batchEvents(50, Duration.ofSeconds(30))
      .concurrency(10)
}

Contributing [WIP]

To build this in development, set up Java, Kotlin and Gradle locally and run the test server:

make dev-ktor

This runs a ktor web server to test the SDK against the dev server.

To run the spring-boot test server:

make dev-spring-boot