You love Swift's Codable protocol and use it everywhere, who doesn't! Here is an easy and very light way to store and retrieve -reasonable amount 😅- of Codable objects, in a couple lines of code!
- Both
UserDefaultsStoreandSingleUserDefaultsStoreare thread safe! - BREAKING: Use of custom encoder/decoder has been removed.
- BREAKING: Snapshots have been removed.
- Add the following to your
Package.swiftfile:
dependencies: [
.package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "3.0.0")
]- Build your project:
$ swift buildAdd the Sources folder to your Xcode project.
Let's say you have 2 structs; User and Laptop defined as bellow:
struct User: Codable {
var id: Int
var firstName: String
var lastName: String
var laptop: Laptop?
}struct Laptop: Codable {
var model: String
var name: String
}Here is how you store them in UserDefaultsStore:
The Identifiable protocol lets UserDefaultsStore knows what is the unique id for each object.
struct User: Codable, Identifiable {
...
}struct Laptop: Codable, Identifiable {
var id: String { model }
...
}let usersStore = UserDefaultsStore<User>(uniqueIdentifier: "users")
let laptopsStore = UserDefaultsStore<Laptop>(uniqueIdentifier: "laptops")let macbook = Laptop(model: "A1278", name: "MacBook Pro")
let john = User(id: 1, firstName: "John", lastName: "Appleseed", laptop: macbook)
// Save an object to a store
try! usersStore.save(john)
// Save an array of objects to a store
try! usersStore.save([jane, steve, jessica])
// Get an object from store
let user = store.object(withId: 1)
let laptop = store.object(withId: "A1278")
// Get all objects in a store
let laptops = laptopsStore.allObjects()
// Check if store has an object
print(usersStore.hasObject(withId: 10)) // false
// Iterate over all objects in a store
laptopsStore.forEach { laptop in
print(laptop.name)
}
// Delete an object from a store
usersStore.delete(withId: 1)
// Delete all objects in a store
laptops.deleteAll()
// Know how many objects are stored in a store
let usersCount = usersStore.objectsCountUse SingleUserDefaultsStore, it enables storing and retrieving a single value of Int, Double, String, or any Codable type.
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
- Swift 5.0+
Special thanks to:
- Paul Hudson for his article on how to use Swift keypaths to write more natural code.
- Batuhan Saka for helping with translation into Turkish
Icon made by freepik from flaticon.com.
UserDefaultsStore is released under the MIT license. See LICENSE for more information.