Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxfast/KStore
A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisation and kotlinx.io
https://github.com/xxfast/KStore
kotlin kotlin-multiplatform kotlinx-coroutines kotlinx-serialization okio
Last synced: 6 days ago
JSON representation
A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisation and kotlinx.io
- Host: GitHub
- URL: https://github.com/xxfast/KStore
- Owner: xxfast
- License: apache-2.0
- Created: 2022-09-06T15:12:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T03:21:56.000Z (15 days ago)
- Last Synced: 2024-10-24T09:13:13.306Z (15 days ago)
- Topics: kotlin, kotlin-multiplatform, kotlinx-coroutines, kotlinx-serialization, okio
- Language: Kotlin
- Homepage: https://xxfast.github.io/KStore/
- Size: 497 KB
- Stars: 511
- Watchers: 2
- Forks: 18
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-kotlin-multiplatform - KStore - A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisation and okio. (Libraries / Storage)
- kmp-awesome - KStore - File-based object storage (Libraries / 📦 Storage)
README
# KStore
[](https://github.com/xxfast/KStore/actions/workflows/build.yml)
[](https://kotlinlang.org/docs/components-stability.html)
[](https://kotlinlang.org)
[](https://search.maven.org/search?q=g:io.github.xxfast)
A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialization and kotlinx.io.
Inspired by [RxStore](https://github.com/Gridstone/RxStore)
## Features
- 🔒 Read-write locks; with a mutex FIFO lock
- 💾 In-memory caching; read once from disk and reuse
- 📬 Default values; no file? no problem!
- 🚚 Migration support; moving shop? take your data with you
- 🚉 Multiplatform!
## Installation
KStore is published on Maven Central. Latest version [](https://search.maven.org/search?q=g:io.github.xxfast)
```kotlin
repositories {
mavenCentral()
// or for snapshot builds
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
```
```toml
# for common
kstore = { module = "io.github.xxfast:kstore", version.ref = "kstore" }
# for android, iOS, desktop and nodeJs
kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore" }
# for jsBrowser and wasmJsBrowser
kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }
```
Depending on your target platforms, you will need to add platform configurations [here](https://xxfast.github.io/KStore/installation.html)
## At a glance
```kotlin
import kotlin.io.path.Path
import kotlinx.serialization.Serializable
// Take any serializable model
@Serializable data class Pet(val name: String, val age: Int)
// Create a store
val store: KStore = storeOf(file = Path("path/to/my_cats.json"))
// Get, set, update or delete values
val mylo: Pet? = store.get()
store.set(mylo)
store.update { pet: Pet? ->
pet?.copy(age = pet.age + 1)
}
store.delete()
// Observe for updates
val pets: Flow = store.updates
```
### Installation and Usage
Documentation [here](https://xxfast.github.io/KStore)
API Reference [here](https://xxfast.github.io/KStore/docs/)
## Licence
Copyright 2023 Isuru Rajapakse
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.