Giter VIP home page Giter VIP logo

kvault's Introduction

CI maven-central OSS Sonatype (Releases)

KVault

KVault is a secure key-value storage for Kotlin Multiplatform projects. It acts as an iOS Keychain wrapper and implements encrypted SharedPreferences for Android.

Import

sourceSets {
    val commonMain by getting {
        dependencies {
            implementation("com.liftric:kvault:<version>")
        }
    }
}

How-to

Init

Android

val store = KVault(context, "<fileName>")
Parameter Description
fileName (optional) Name of the shared preferences file

iOS

val store = KVault("<serviceName>", "<accessGroup>")
Parameter Description
serviceName (optional) Used to categories objects
accessGroup (optional) Used to share objects between apps

Setting

val stringStored: Boolean = store.set(key = "LEET", stringValue = "1337")
val intStored: Boolean = store.set(key = "ANSWER", intValue = 42)
val floatStored: Boolean = store.set(key = "PI", floatValue = 3.14)

Supported Types

  • String
  • Int
  • Long
  • Float
  • Double
  • Bool

Getting

val stringValue: String? = store.string(forKey = "PASSWORD")
val intValue: Int? = store.int(forKey = "SECRET")

To check if an object is stored you can use:

val existsObject: Boolean = store.existsObject(forKey = "PASSWORD")

To check for which keys objects are stored:

val allKeys: List<String> = store.allKeys()

Deleting

Single object

val isRemoved: Boolean = store.removeObject(forKey = "PASSWORD")

All objects

val isCleared: Boolean = store.clear()

License

KVault is available under the MIT license. See the LICENSE file for more info.

kvault's People

Contributors

gaebel avatar benjohnde avatar raibaz avatar jha-vineet69 avatar cladvd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.