Package-level declarations

Types

open class Attributes @JvmOverloads constructor(val text: Map<String, String> = mapOf(), val number: Map<String, Number>? = null, val anonymous: Boolean = false)

Extra attributes to be used for evaluating features.

BooleanFeatureFlag

interface BooleanFeatureFlag : FeatureFlag<Boolean>

DoubleFeatureFlag

interface DoubleFeatureFlag : FeatureFlag<Double>

DynamicConfig

interface DynamicConfig

Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don't support different variations for different keys.

EnumFeatureFlag

interface EnumFeatureFlag<T : Enum<T>> : FeatureFlag<T>

A Enumeration feature flag, when evaluated returns T

Feature

open class Feature(val name: String)

Typed feature string.

FeatureFlag

sealed interface FeatureFlag<T : Any>

FeatureFlags

interface FeatureFlags : StrongFeatureFlags, LegacyFeatureFlags

Interface for evaluating feature flags.

FeatureFlagValidation

object FeatureFlagValidation

IntFeatureFlag

interface IntFeatureFlag : FeatureFlag<Int>

JsonFeatureFlag

interface JsonFeatureFlag<T : Any> : FeatureFlag<T>

A JSON feature flag, when evaluated returns T.

LegacyFeatureFlags

interface LegacyFeatureFlags

StringFeatureFlag

interface StringFeatureFlag : FeatureFlag<String>

StrongFeatureFlags

interface StrongFeatureFlags

TrackerReference

interface TrackerReference

Functions

fromSafeJson

fun <T> JsonAdapter<T>.fromSafeJson(value: String): T?

fun <T> JsonAdapter<T>.fromSafeJson(json: String, onUnknownFields: (JsonDataException) -> Unit): T?

Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.

getEnum

inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T

inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T

getJson

inline fun <T> DynamicConfig.getJson(feature: Feature): T

inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T

toSafeJson

fun <T> JsonAdapter<T>.toSafeJson(value: T): String

fun <T> JsonAdapter<T>.toSafeJson(value: T, onUnknownFields: (JsonDataException) -> Unit): String

Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.

trackEnum

inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference

inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference

trackJson

inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference

inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference