Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n7ghtm4r3/kmprefs
Kotlin Multiplatform Preferences system
https://github.com/n7ghtm4r3/kmprefs
android desktop ios kotlin kotlin-multiplatform kotlin-multiplatform-library localstorage nsuserdefaults preferences sharedpreferences tecknobit wasm
Last synced: about 1 month ago
JSON representation
Kotlin Multiplatform Preferences system
- Host: GitHub
- URL: https://github.com/n7ghtm4r3/kmprefs
- Owner: N7ghtm4r3
- License: apache-2.0
- Created: 2024-11-24T19:29:10.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-26T13:35:54.000Z (about 1 month ago)
- Last Synced: 2024-11-27T01:56:22.333Z (about 1 month ago)
- Topics: android, desktop, ios, kotlin, kotlin-multiplatform, kotlin-multiplatform-library, localstorage, nsuserdefaults, preferences, sharedpreferences, tecknobit, wasm
- Language: Kotlin
- Homepage:
- Size: 336 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KMPrefs
**v1.0.0**
The Kotlin Multiplatform Pref(erence)s system allows you to store, retrieve, and remove data locally on each platform.
It leverages the native mechanisms provided by each platform.
## Implementation
### Version catalog
```gradle
[versions]
kmprefs = "1.0.0"
[libraries]
kmprefs = { module = "io.github.n7ghtm4r3:KMPrefs", version.ref = "kmprefs" }
```
### Gradle
Add the JitPack repository to your build file (just if you have **Android** target)
- Add it in your root build.gradle at the end of repositories
```gradle
repositories {
...
maven { url 'https://jitpack.io' }
maven { url 'https://repo.clojars.org' }
}
```
#### Gradle (Kotlin)
```gradle
repositories {
...
maven("https://jitpack.io")
maven("https://repo.clojars.org")
}
```
- Add the dependency
```gradle
dependencies {
implementation 'io.github.n7ghtm4r3:KMPrefs:1.0.0'
}
```
#### Gradle (Kotlin)
```gradle
dependencies {
implementation("io.github.n7ghtm4r3:KMPrefs:1.0.0")
}
```
#### Gradle (version catalog)
```gradle
dependencies {
implementation(libs.kmprefs)
}
```
## Core functionality
### Supported types
| **Type** | **Description** |
|------------------|--------------------------------------------|
| `Boolean` | Boolean type (true/false) |
| `BooleanArray` | Array of `Boolean` |
| `Byte` | 8-bit signed integer |
| `ByteArray` | Array of `Byte` |
| `UByte` | 8-bit unsigned integer |
| `UByteArray` | Array of `UByte` |
| `Short` | 16-bit signed integer |
| `ShortArray` | Array of `Short` |
| `UShort` | 16-bit unsigned integer |
| `UShortArray` | Array of `UShort` |
| `Int` | 32-bit signed integer |
| `IntArray` | Array of `Int` |
| `UInt` | 32-bit unsigned integer |
| `UIntArray` | Array of `UInt` |
| `Float` | 32-bit floating-point number |
| `FloatArray` | Array of `Float` |
| `Double` | 64-bit floating-point number |
| `DoubleArray` | Array of `Double` |
| `Long` | 64-bit signed integer |
| `LongArray` | Array of `Long` |
| `ULong` | 64-bit unsigned integer |
| `ULongArray` | Array of `ULong` |
| `String` | String of characters |
### Store values
Same procedure for all the types
```kotlin
val kmPrefs = KMPrefs("your_storage_path") // create an instance
// for example store a Double value
kmPrefs.storeDouble(
key = "constant", // the key of the double value to store
value = 3.14159265359 // the double value to store
)
```
### Retrieve values
Same procedure for all the types
```kotlin
// for example retrive a Double value
val constant = kmPrefs.retrieveDouble(
key = "constant",
defValue = 1.6180339887 // a default value to use if the searched one is not stored yet
)
```
### Remove values
```kotlin
// same method for all the types
kmPrefs.removeValue(
key = "constant"
)
```
## Authors
- [@N7ghtm4r3](https://www.github.com/N7ghtm4r3)
## Support
If you need help using the library or encounter any problems or bugs, please contact us via the
following links:
- Support via email
- Support via GitHub
Thank you for your help!
## Donations
If you want support project and developer
| Crypto | Address | Network |
|-----------------------------------------------------------------------------------------------------|--------------------------------------------------|----------|
|  | **3H3jyCzcRmnxroHthuXh22GXXSmizin2yp** | Bitcoin |
|  | **0x1b45bc41efeb3ed655b078f95086f25fc83345c4** | Ethereum |
|  | **AtPjUnxYFHw3a6Si9HinQtyPTqsdbfdKX3dJ1xiDjbrL** | Solana |
If you want support project and developer
with PayPal
Copyright © 2024 Tecknobit