kachetor
1.1.0indexedEnhances persistent caching for HTTP clients using LRU eviction strategy, integrates with Ktor, supports fallback to in-memory cache, and allows custom cache directory configuration.
29
Stars
—
Used by
dependents
—
Health
/ 100
Kachetor
Kachetor is an easy-to-use Kotlin Multiplatform caching library to support persistent cache with Ktor client.
Supported platforms:
- Android
- iOS (iosArm64, iosX64, iosSimulatorArm64)
Why use Kachetor?
- It complements Ktor by enabling persistent caching on platforms beyond the JVM, which Ktor currently supports.
- Uses LRU eviction strategy by using Kache a Kotlin Multiplatform caching library.
Setup (Gradle)
commonMain.dependencies {
implementation("com.vipulasri.kachetor:kachetor:<version>")
}
Don't forget to replace with the latest found on the badges above or the desired version.
Usage
Simple
Provide the Kachetor instance to the HttpCache plugin and you are good to go.
install(HttpCache) {
publicStorage(KachetorStorage(10 * 1024 * 1024)) // 10MB
}
Kachetor uses platform-specific default cache directories:
- Android:
context.cacheDir- This refers to the application's cache directory on the Android device. - iOS:
cachesdirectory - This refers to the application's caches directory within the iOS sandbox.
Advanced
Allows storage of the cache in a custom directory:
install(HttpCache) {
publicStorage(KachetorStorage("provide-platform-specific-directory-path", 10 * 1024 * 1024))
}
Fallback Mechanism
If Kachetor cannot create a persistent cache due to an issue, it will use an in-memory cache as a fallback.
License
Copyright 2024 Vipul Asri
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
https:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.