Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmdias/DefaultsKit
Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS
https://github.com/nmdias/DefaultsKit
ios macos swift swift-framework swift4 tvos userdefaults
Last synced: about 1 month ago
JSON representation
Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS
- Host: GitHub
- URL: https://github.com/nmdias/DefaultsKit
- Owner: nmdias
- License: mit
- Created: 2017-08-19T14:51:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-20T03:44:25.000Z (over 1 year ago)
- Last Synced: 2024-07-18T15:45:09.580Z (2 months ago)
- Topics: ios, macos, swift, swift-framework, swift4, tvos, userdefaults
- Language: Swift
- Homepage:
- Size: 81.1 KB
- Stars: 1,430
- Watchers: 15
- Forks: 94
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - UserDefaults - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS. (Database / Getting Started)
- awesome-swift - DefaultsKit - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS. (Libs / Data Management)
- awesome-swift - DefaultsKit - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS. (Libs / Data Management)
- fucking-awesome-swift - DefaultsKit - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS. (Libs / Data Management)
- awesome-ios-star - UserDefaults - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS. (Database / Getting Started)
- awesome-swift - DefaultsKit - Simple, Strongly Typed UserDefaults for iOS, macOS and tvOS ` đ 8 months ago` (Data Management [đ](#readme))
README
[](https://cocoapods.org/pods/DefaultsKit)
[](https://github.com/Carthage/Carthage)
[](https://swift.org)
[](https://github.com/nmdias/DefaultsKit/releases)
[įŽäŊä¸æ](README.zh-CN.md)
DefaultsKit leverages **Swift 4**'s powerful [Codable](https://developer.apple.com/documentation/swift/codable) capabilities to provide a **Simple** and **Strongly Typed** wrapper on top of [UserDefaults](https://developer.apple.com/documentation/foundation/userdefaults). It uses less than 70 lines of code to acomplish this.
Installation >> [`instructions`](https://github.com/nmdias/DefaultsKit/blob/master/INSTALL.md) <<
## Usage
Instantiate, or get a `shared` instance of `Defaults`
```swift
let defaults = Defaults() // or Defaults.shared
```
Then:
```swift
// Define a key
let key = Key("someKey")
// Set a value
defaults.set("Codable FTW đ", for: key)
// Read the value back
defaults.get(for: key) // Output: Codable FTW đ
```
### Check if a key has a value:
```swift
if defaults.has(key) {
// Do your thing
}
```
> If you just need to know that a key/value pair exists, **without actually using the value**, use the `has()` method instead of the optional `get(for:key)`. For complex objects it will prevent any unnecessary deserialization.
### Implicit Member Expression
You can find a convenience wrapper for your keys by extending `DefaultsKey`. This allows you use [Implicit Member Expression](https://docs.swift.org/swift-book/ReferenceManual/Expressions.html#//appleref/swift/grammar/implicit-member-expression):
```swift
// Extend with a custom key
extension DefaultsKey {
static let someKey = Key("someKey")
}
// Then use it like this
defaults.set("Some key", for: .someKey)
defaults.get(for: .someKey) // Output: Some key
```
### Complex objects
To store a complex object just conform to the [Codable](https://developer.apple.com/documentation/swift/codable) protocol:
```swift
struct Person: Codable {
let name: String
let age: Int
}
```
Then:
```swift
// Create a key
let key = Key("personKey")
// Get an instance of your Codable conforming enum, struct or class
let person = Person(name: "Bonnie Greenwell", age: 80)
// Set the value
defaults.set(person, for: key)
```
And finally:
```swift
// Read it back
let person = defaults.get(for: key)
person?.name // Bonnie Greenwell
person?.age // 80
```
### Nested Objects
You can also use nested objects as long as they conform to the `Codable` protocol:
```swift
enum Pet: String, Codable {
case cat
case dog
}
struct Person: Codable {
let name: String
let pets: [Pet]
}
// Get a Codable conforming instante
let person = Person(name: "Claire", pets: [.cat])
// Set the value
defaults.set(person, for: key)
// And read it back
let person = defaults.get(for: key)
person?.name // Claire
person?.pets.first // cat
```
## License
DefaultsKit is released under the MIT license. See [LICENSE](https://github.com/nmdias/DefaultsKit/blob/master/LICENSE) for details.
### Help Wanted
#### Review/Translate [README.zh-CN.md](README.zh-CN.md) to Chinese
Chinese is the #1 spoken language in the world and I'd love to have DefaultsKit be more inclusive, unfortunately I don't speak Chinese. If you know chinese, and would like to help out, please see [issue #1](https://github.com/nmdias/DefaultsKit/issues/1)
Thank you đ