A Turkish version of this document can be found here.
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!
CocoaPods (Recommended)
To integrate UserDefaultsStore into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'UserDefaultsStore'Carthage
To integrate UserDefaultsStore into your Xcode project using Carthage, specify it in your Cartfile:
github "omaralbeik/UserDefaultsStore" ~> 1.0
Swift Package Manager
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but UserDefaultsStore does support its use on supported platforms.
Once you have your Swift package set up, adding UserDefaultsStore as a dependency is as easy as adding it to the dependencies value of your Package.swift.
import PackageDescription
dependencies: [
.package(url: "https://github.com/omaralbeik/UserDefaultsStore.git", from: "1.0.2")
]
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 {
static let idKey = \User.id
...
}struct Laptop: Codable, Identifiable {
static let idKey = \Laptop.model
...
}Notice how
UserusesIntfor its id, whileLaptopusesString, in fact the id can be anyHashabletype. UserDefaults uses Swift keypaths to refer to properties without actually invoking them. Swift rocks 🤘
let usersStore = UserDefaultsStore<User>(uniqueIdentifier: "users")!
let laptopsStore = UserDefaultsStore<Laptop>(uniqueIdentifier: "laptops")!let macbook = Laptop(model: "A1278", name: "MacBook Pro")
let john = User(userId: 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.
At the moment, only final classes are supported, please take this into consideration before using the library.
- iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 10.0+
- Swift 4.2+
Special thanks to:
- Paul Hudson for his article on how to use Swift keypaths to write more natural code.
- Batuhan Saka for translating this document into Turkish.
Icon made by freepik from flaticon.com.
UserDefaultsStore is released under the MIT license. See LICENSE for more information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent