Skip to content

Commit

Permalink
Add missing KDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
kevincianfarini committed Mar 6, 2024
1 parent fb8fb8b commit 1e89ff1
Showing 1 changed file with 27 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,45 @@ package io.github.kevincianfarini.monarch.launchdarkly
*/
public interface LaunchDarklyClientShim {

/**
* Return a [Boolean] value [forKey], or [default] if no value exists.
*/
public fun boolVariation(forKey: String, default: Boolean): Boolean

/**
* Return an [Int] value [forKey], or [default] if no value exists.
*/
public fun intVariation(forKey: String, default: Int): Int

/**
* Return a [Double] value [forKey], or [default] if no value exists.
*/
public fun doubleVariation(forKey: String, default: Double): Double

/**
* Return a [String] value [forKey], or [default] if no value exists.
*/
public fun stringVariation(forKey: String, default: String): String

/**
* Return a JSON encoded [String] value [forKey], or [default] if no value exists.
*/
public fun jsonStringVariation(forKey: String, default: String?): String?

/**
* Register a [handler] to be invoked when the value associated with [key] changes, scoped
* to [owner].
*/
public fun observe(key: String, owner: ObserverOwner, handler: () -> Unit)

/**
* Unregister all observers scoped to [owner].
*/
public fun stopObserving(owner: ObserverOwner)
}

public class ObserverOwner
/**
* A marker object used in [LaunchDarklyClientShim.observe] and
* [LaunchDarklyClientShim.stopObserving].
*/
public class ObserverOwner internal constructor()

0 comments on commit 1e89ff1

Please sign in to comment.