RxUserDefaults

Overview

Reactive UserDefaults, inspired by rx-preferences.

Typehandling was inspired by wrap and unbox

Usage

To create a setting use the constructor of that class:

let settings = RxSettings(userDefaults: userDefaults)
let setting = settings.setting(key: "INSERT_KEY", defaultValue: "DEFAULT")

The arguments should be self explanatory.

Currently only following Types are supported:

• String
• Int
• Bool
• Array (only with the types supported by the UserDefaults)
• Enum (but enum must conform to the RxSettingEnum protocol)

Functions you can use:

// gets the value
let val = setting.value

// sets the value
setting.value = val

// check if value is saved (note: the default value is not automatically saved)
setting.isSet

// deletes the value
setting.remove()

// provides a hot observable that triggers on every change
// and starts with the current value (or default value)
setting.asObservable()

Storage Layer

If you do not want to use the UserDefaults as a storage layer you can implement your own. To do this you have to confirm to the StorageLayer Protocol.

Warnings & TODOs

I want to support everything that the UserDefaults support (e.g. Dictionary, URL ...). For now you can expand the library to more types by conforming to the RxSettingCompatible protocol. But note that persisting types that are not supported by the UserDefaults will fail silently.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

RxUserDefaults is available through:

• Carthage To install, simply add the following line to your Cartfile:

github "num42/RxUserDefaults"

• CocoaPods To install, simply add the following line to your Podfile:

pod "RxUserDefaults"

Requirements

• RxSwift

Project

The xcodeproj file is generated using xcodegen.

To update it from the project.yml, run

xcodegen

or, if you are using mint

mint run yonaskolb/XcodeGen

Author

David Kraus, [email protected]

Hans-Martin Schuller, [email protected]

Wolfgang Lutz, [email protected]

License

Copyright 2018 Number42 GmbH

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.