https://github.com/danielepantaleone/persistedproperty
A lightweight framework to persist iOS properties written in Swift
https://github.com/danielepantaleone/persistedproperty
keychain persistable persistence properties property-wrapper storage user-defaults
Last synced: 11 months ago
JSON representation
A lightweight framework to persist iOS properties written in Swift
- Host: GitHub
- URL: https://github.com/danielepantaleone/persistedproperty
- Owner: danielepantaleone
- License: mit
- Created: 2023-06-16T09:18:13.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T13:01:36.000Z (over 2 years ago)
- Last Synced: 2025-02-21T15:02:51.969Z (over 1 year ago)
- Topics: keychain, persistable, persistence, properties, property-wrapper, storage, user-defaults
- Language: Swift
- Homepage:
- Size: 104 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/danielepantaleone/PersistedProperty)
[](https://swiftpackageindex.com/danielepantaleone/PersistedProperty)
[](https://github.com/danielepantaleone/PersistedProperty/actions/workflows/swift-tests.yml)
A Swift-based lightweight framework that enable the persistence of Swift properties on a pre-configured storage.
## Table of contents
* [Feature Highlights](#feature-highlights)
* [Basic usage](#basic-usage)
* [Advanced usage](#advanced-usage)
* [Installation](#installation)
* [Cocoapods](#cocoapods)
* [Swift Package Manager](#swift-package-manager)
* [Contributing](#contributing)
* [License](#license)
## Feature Highlights
- Compatible with iOS and macOS
- Native support for `UserDefaults` based storage
- Native support for iOS `KeyChain` based storage
- Property persistence achieved through the `@Persisted` property wrapper
- Properties wrapped with `@Persisted` must conform to the `Codable` protocol
- Possibility to specify your custom storage facility
## Basic usage
Creating a persisted property it's just a matter of adding the `@Persisted` property wrapper on top of your variable, specifying the key used to reflect the property value on the storage and assigning a default value to the property itself. If the property is `Optional` and no default value is provided, `nil` must be specified:
```swift
@Persisted(key: "myProperty")
var myProperty: Double = 10.0
@Persisted(key: "myOptionalProperty")
var myOptionalProperty: String? = nil // default value cannot be omitted
```
## Advanced usage
It's possible to customize on which storage service properties are going to be persisted. `PersistedProperty` provide native support for `UserDefaults` backed storage and `KeyChain` based storage. You can configure which storage to use when adding the `@Persisted` property wrapper on top of your property:
```swift
// This will be persisted in the standard UserDefaults (same as omitting the storage parameter).
@Persisted(key: "myProperty", storage: .standard)
var myProperty: Double = 10.0
// This will be persisted in the iOS KeyChain.
@Persisted(key: "myPassword", storage: .keychain)
var myPassword: String? = nil
```
Additionally, you can specify your custom storage service by creating your storage provider that conforms to the `StorageService` protocol:
```swift
/// A custom storage provider conforming to the StorageService protocol
class MyCustomStorageService: StorageService {
func load(key: String) -> ValueType? where ValueType: Codable ...
func save(_ value: ValueType, key: String) where ValueType: Codable ...
func remove(key: String) ...
}
let myService: StorageService = MyCustomStorageService()
// This will be persisted in the custom storage service.
@Persisted(key: "myProperty", storage: .custom(service: myService))
var myProperty: Double = 10.0
```
## Installation
### Cocoapods
Add the dependency to the `PersistedProperty` framework in your `Podfile`:
```ruby
pod 'PersistedProperty', '~> 1.1.0'
```
### Swift Package Manager
Add it as a dependency in a Swift Package:
```swift
dependencies: [
.package(url: "https://github.com/danielepantaleone/PersistedProperty.git", .upToNextMajor(from: "1.1.0"))
]
```
## Contributing
If you like this project you can contribute it by:
- Submit a bug report by opening an [issue](https://github.com/danielepantaleone/PersistedProperty/issues)
- Submit code by opening a [pull request](https://github.com/danielepantaleone/PersistedProperty/pulls)
## License
```
MIT License
Copyright (c) 2023 Daniele Pantaleone
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```