ff4k-core/com.yonatankarp.ff4k

Package-level declarations

Types

data class FeatureStats(val total: Int, val enabled: Int, val disabled: Int, val withPermissions: Int, val withStrategy: Int, val groups: Int)

Aggregated statistics about features in an FF4k instance.

FF4k

class FF4k(val featureStore: FeatureStore = InMemoryFeatureStore(), val propertyStore: PropertyStore = InMemoryPropertyStore(), val source: FF4k.Source = Source.KotlinApi, val autoCreate: Boolean = false)

The primary entry point and facade for the FF4K feature flag library.

Functions

checkAll

suspend fun FF4k.checkAll(vararg featureIds: String, executionContext: FlippingExecutionContext? = null): Boolean

Check if all features in the list are enabled.

checkAny

suspend fun FF4k.checkAny(vararg featureIds: String, executionContext: FlippingExecutionContext? = null): Boolean

Check if any feature in the list is enabled.

disabledFeatures

suspend fun FF4k.disabledFeatures(): List<Feature>

Get all disabled features.

enabledFeatures

suspend fun FF4k.enabledFeatures(): List<Feature>

Get all enabled features.

featuresWithPermission

suspend fun FF4k.featuresWithPermission(permission: String): List<Feature>

Get features with a specific permission.

featuresWithStrategy

suspend fun FF4k.featuresWithStrategy(): List<Feature>

Get features with a flipping strategy.

ifEnabled

inline suspend fun <T> FF4k.ifEnabled(featureId: String, executionContext: FlippingExecutionContext? = null, block: () -> T): T?

Execute a block if the feature is enabled.

ifEnabledOrElse

inline suspend fun <T> FF4k.ifEnabledOrElse(featureId: String, executionContext: FlippingExecutionContext? = null, enabled: () -> T, disabled: () -> T): T

Execute one block if the feature is enabled, another if disabled.

report

suspend fun FF4k.report(): String

Get a summary report of all features.

stats

suspend fun FF4k.stats(): FeatureStats

Get statistics about features.

whenEnabled

inline suspend fun FF4k.whenEnabled(featureId: String, executionContext: FlippingExecutionContext? = null, block: () -> Unit)

Execute a block with side effects if the feature is enabled.