jokeapi/README.md
2022-09-21 23:35:02 -07:00

578 B

JokeAPI for Kotlin/Java

A simple Kotlin/Java library to retrieve jokes from Sv443's JokeAPI.

Examples (TL;DR)

import net.thauvin.erik.jokeapi.JokeApi.Companion.getJoke

val joke = getJoke()
val safe = getJoke(safe = true)
val pun = getJoke(category = Category.PUN)

A Joke class instance is returned:

data class Joke(
    val error: Boolean,
    val category: Category,
    val type: Type,
    val joke: Set<String>,
    val flags: Set<Flag>,
    val id: Int,
    val safe: Boolean,
    val language: Language
)